Notes about github actions and posix-compliant examples

Author: Dimos082

README.md

@@ -1,3 +1,4 @@
+
 # CLI Monitor 🖥️ 
 
 > **CLI Monitor** is a *cross-platform* Python tool that repeatedly runs a command, captures its output, optionally logs it, and can even trigger a secondary command whenever a regex pattern is matched.
@@ -7,13 +8,14 @@
 **Unittests status for Win/Lin/Mac environments:** [![Python Multi-OS Tests](https://github.com/Dimos082/cli-monitor/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/Dimos082/cli-monitor/actions/workflows/test.yml) 
 
 <details>
-  <summary>📖 Table of Contents</summary>
+  <summary>📖 Table of Contents (expandable)</summary>
 
 - [Overview](#overview)
 - [Features](#features)
 - [Quick Start](#quick-start)
 - [Example Commands](#example-commands)
 - [Arguments Overview](#arguments-overview)
+- [Automated Version Bumping, Testing and Release](#bumping)
 - [Contributing](#contributing)
 - [License](#license)
 </details>
@@ -33,13 +35,17 @@ CLI Monitor is designed to help automate command execution, log outputs, and mon
 
 ## ▶️ Quick Start <a id="quick-start"></a>
 
-1. **Download** [cli_monitor.py](https://raw.githubusercontent.com/Dimos082/cli-monitor/refs/heads/main/cli_monitor.py).
-2. **Run with an argument**:
+1. **Download** [cli_monitor.py](https://raw.githubusercontent.com/Dimos082/cli-monitor/refs/heads/main/cli_monitor.py). **Or clone:**
+   ```bash
+   git clone https://github.com/Dimos082/cli-monitor.git
+   cd cli-monitor
+   ```
+3. **Run with an argument**:
    ```bash
    python cli_monitor.py --command "echo Hello"
    ```
-3. **Stop** it at any time (e.g., Ctrl + C) or specify a timer with `--timer`.
-4. **Check** the summary in terminal (or in log file if `--output-file` specified) after. Example:
+4. **Stop** it at any time (e.g., Ctrl + C) or specify a timer with `--timer`.
+5. **Check** the summary in terminal (or in log file if `--output-file` specified) after. Example:
 ```bash
 ----- Execution Summary -----
 Start Time: 2025-01-04 22:43:24.021834
@@ -72,18 +78,18 @@ This command checks every 10 seconds if `my_app` is running. If not, it triggers
 ### Repeating Echo
 
 ```bash
-python cli_monitor.py --command "echo Hello" --frequency 3
+python cli_monitor.py --frequency 3 --command echo 'Checking System'
 ```
 
-Prints "Hello" every 3 seconds.
+Prints "Checking System" every 3 seconds.
 
 ###  Log File Management
 
 ```bash
-python cli_monitor.py --command "ls -la" --output-file "/tmp/mylog.txt" --max-log-size 50
+python cli_monitor.py --output-file memory_log.txt --max-log-size 5 --command echo 'Memory Status: OK'
 ```
 
-Keeps logs within 50 KB by trimming older entries.
+Keeps logs within 5 KB by trimming older entries.
 
 ### Detecting Errors in Logs
 
@@ -112,15 +118,44 @@ Runs for 10 seconds, searching for "error" or "fail" and executing an alert comm
 
 [🔼 Back to top](#cli-monitor-️)
 
+## 🔄 Automated Version Bumping, Testing and Release <a id="bumping"></a>
+
+**GitHub Actions will:**
+- [Run tests in several environments](https://github.com/Dimos082/cli-monitor/blob/main/.github/workflows/test.yml)
+- Bump version in cli_monitor.py
+-  Create a [GitHub Release](https://github.com/Dimos082/cli-monitor/releases)
+- Attach cli_monitor.py for download
+
+[GitHub Actions](https://github.com/Dimos082/cli-monitor/tree/main/.github/workflows) automatically bumps versions when commit messages include specific keywords:
+- Patch (X.Y.Z+1********) → PATCH: Fixed issue
+- Minor (X.Y+1.0********) → MINOR: Added logging
+- Major (X+1.0.0********) → MAJOR: Breaking change
+
+**Triggering a Release:**
+To increment a patch number `1.0.1+`:
+```bash
+git commit -m "PATCH: Fixed issue in regex matching"
+git push origin main
+```
+To increment major number `1+.0.0`, commit a major change:
+```bash
+git commit -m "MAJOR: Refactored CLI to use POSIX structure"
+git push origin main
+```
+
+[🔼 Back to top](#cli-monitor-️)
+
 ## 🛠️ Contributing <a id="contributing"></a>
 
+If you find a bug or have a feature request, check out [open issues](https://github.com/Dimos082/cli-monitor/issues) or create a new one. Your feedback is valuable!
+
 I welcome contributions to make CLI Monitor even better! If you have an idea for an improvement or new [test cases](https://github.com/Dimos082/cli-monitor/tree/main/tests), feel free to:
 
 - **Fork the repository**
 - **Create a new feature branch**:
   `git checkout -b feature/NewFeature`
-- **Make your changes and commit**:
-  `git commit -m "Added NewFeature"`
+- **Make your changes and commit with the version number incrementation**:
+  `git commit -m "MINOR: Added feature XYZ"`
 - **Push your changes**: `git push origin feature/NewFeature`
 - **Open a pull request**  🐈‍⬛
 
@@ -131,13 +166,10 @@ The controller (subject) runs commands, logs output, and notifies other modules
 This structure makes the code more maintainable and extensible.
 To add a new “observer” (e.g., a custom notification module), simply attach it to the flow in the controller without modifying existing logic significantly.
 
-If you find a bug or have a feature request, check out [open issues](https://github.com/Dimos082/cli-monitor/issues) or create a new one. Your feedback is valuable!
-
-If you find [cli_monitor.py](https://raw.githubusercontent.com/Dimos082/cli-monitor/refs/heads/main/cli_monitor.py) useful, consider giving it a ⭐ on GitHub!
-
-
 ## 📜 License <a id="license"></a>
 
 This project is licensed under the Apache 2.0 - see the [LICENSE](https://github.com/Dimos082/cli-monitor?tab=Apache-2.0-1-ov-file) file for details.
 
-[🔼 Back to top](#cli-monitor-️) 
+If you find [cli_monitor.py](https://raw.githubusercontent.com/Dimos082/cli-monitor/refs/heads/main/cli_monitor.py) useful, consider giving it a ⭐ on GitHub!
+
+[🔼 Back to top](#cli-monitor-️)