Add CI workflows

template.ini → .commit-format

@@ -1,6 +1,6 @@
 [header]
 # header line regex:
-pattern = ^(option: |requirements: |doc: |release: ).+$
+pattern = ^(option: |requirements: |ci: |doc: |release: ).+$
 
 [body]
 # Allow empty body commit message. (i.e. single line commit message).

.github/workflows/commit-format.yml

@@ -0,0 +1,24 @@
+name: commit-format 🔍
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install codespell
+    - name: commit-format 
+      run: |
+        git fetch --no-tags --depth=1 origin main
+        python commit_format/commit_format.py -t .commit-format -v -b origin/main

.github/workflows/pylint.yml

@@ -0,0 +1,23 @@
+name: Pylint 🐍
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint
+    - name: Pylint 🐍
+      run: |
+        pylint $(git ls-files '*.py')

.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: Publish Python 🐍 distribution 📦 to PyPI
+name: Build and Publish
 
 on: push
 

README.md

@@ -3,7 +3,7 @@ A tool to check your commit messages format.
 
 ## Supported checkers
 
-Primarly disigned for to check for spelling mistakes in commit messages,
+Primarily disigned for to check for spelling mistakes in commit messages,
 `commit-format` now comes with various checker allowing to:
 
 - Check that each message lines does not exceed a length limit.
@@ -49,16 +49,16 @@ $ commit-format -ns
 
 ### -t (--template FILE) Template compliance
 
-You can provide a simple INI template to validate the commit header/footer format
+You can provide a configuration TOML file template to validate the commit header/footer format
 and required symbols.
 
 Usage:
 
 ```sh
-$ commit-format -t /path/to/template.ini
+$ commit-format -t /path/to/.commit-format
 ```
 
-Template schema (INI):
+Template schema (TOML):
 
 - [header]
   - pattern: Regex that the first line (header) must match.
@@ -69,27 +69,33 @@ Template schema (INI):
   - required: true/false to require a footer section.
   - pattern: Regex that each footer line must match.
 
-Example `template.ini`:
+Example `.commit-format`:
 
-```ini
+```toml
 [header]
-pattern = ^(feat: |fix: |doc: |ci: ).+$
+# header line regex:
+pattern = ^(feat: |fic: |ci: |doc: ).+$
 
-[structure]
+[body]
+# Allow empty body commit message. (i.e. single line commit message).
 allow_empty = false
+# Require that header line and body line are separated by an empty line.
 blank_line_after_header = true
 
 [footer]
+# Require a footer line
 required = true
+# Footer line regex
 pattern = ^(Signed-off-by: ).+$
+
 ```
 
 ## Behavior option
 
 ### -a (--all) Force checking all commits
 
 By default the script will only run on a branch and stop when reaching the base branch.  
-If run on a base branch direclty, the script will throw an error:
+If run on a base branch directly, the script will throw an error:
 
 ```sh
 $ commit-format
@@ -114,12 +120,15 @@ As described in [option -a section](#a---all-force-checking-all-commits) the bas
 to let the script restrict it's analysis on the commits of a branch.    
 Default value for the base branch name is `main`.  
 
+> When running this script in a CI environment, you may be required to fetch your base branch
+> manually. See [github workflow](.github/workflows/commit-format.yml) example.
+
 Usage:
 
 ```sh
-$ commit-format -b master
+$ commit-format -b origin/main
 ```
 
 ### -v (--verbosity)
 
-Diplay debug messages from the script.
+Display debug messages from the script.

commit_format/__init__.py

@@ -1 +1,2 @@
+# pylint: skip-file
 __author__ = 'Alex Fabre'