Merge branch 'main' into wsen-pads-extand-example

Author: Charly-sketch

.github/workflows/check-commits.yml

@@ -14,22 +14,19 @@ jobs:
   check-commit-messages:
     runs-on: ubuntu-latest
     steps:
-      - name: "📜 Check commit messages format"
-        uses: gsactions/commit-message-checker@v1
+      - name: "⏳ Checkout repository"
+        uses: actions/checkout@v4
         with:
-          pattern: '^[^!]+: [A-Za-z]+.+ .+\.$'
-          flags: "gm"
-          error: "Commit subject line must match the following pattern: <scope>: <description>."
-          excludeTitle: "false"
-          excludeDescription: "true"
-          checkAllCommitMessages: "true"
-          accessToken: ${{ secrets.GITHUB_TOKEN }}
-      - name: "📜 Check commit messages length"
-        uses: gsactions/commit-message-checker@v1
+          fetch-depth: 0
+
+      - name: "🟢 Set up Node.js"
+        uses: actions/setup-node@v4
         with:
-          pattern: "^[^#].{10,78}$"
-          error: "Commit subject line maximum line length of 78 characters is exceeded."
-          excludeTitle: "false"
-          excludeDescription: "true"
-          checkAllCommitMessages: "true"
-          accessToken: ${{ secrets.GITHUB_TOKEN }}
+          node-version: "20.17.x"
+          cache: "npm"
+
+      - name: "🛠 Install commitlint"
+        run: npm ci --ignore-scripts
+
+      - name: "📜 Validate commit messages"
+        run: npx --no-install commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose

.github/workflows/python-linter.yml

@@ -1,6 +1,3 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
-
 name: "🔎 Python Linter"
 
 on:
@@ -10,26 +7,22 @@ on:
     branches: ["main"]
 
 jobs:
-  build:
+  lint:
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
 
     steps:
       - name: "⏳ Checkout repository"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: "🐍 Set up Python"
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           cache: "pip"
+          cache-dependency-path: pyproject.toml
           python-version: "3.10"
 
       - name: "🛠 Install dependencies"
-        run: |
-          pip install -r .github/workflows/requirements.txt
-          ruff --version
-          pytest --version
+        run: python3 -m pip install -e ".[dev]"
 
       - name: "😾 Lint with ruff"
-        run: ruff check
+        run: make lint

.github/workflows/requirements.txt

@@ -9,25 +9,23 @@ on:
 jobs:
   mock-tests:
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
 
     steps:
       - name: "⏳ Checkout repository"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: "🐍 Set up Python"
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           cache: "pip"
+          cache-dependency-path: pyproject.toml
           python-version: "3.10"
 
       - name: "🛠 Install dependencies"
-        run: |
-          pip install -r .github/workflows/requirements.txt
+        run: python3 -m pip install -e ".[dev,test]"
 
       - name: "🧪 Run mock tests"
-        run: python -m pytest tests/ -v -k mock
+        run: make test-mock
 
       - name: "📋 Validate examples"
-        run: python -m pytest tests/test_examples.py -v
+        run: make test-examples

.github/workflows/tests.yml

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+npx --no-install commitlint --edit "$1"

.husky/commit-msg

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+npx --no-install validate-branch-name && npx --no-install git-precommit-checks && npx --no-install lint-staged

.husky/pre-commit

@@ -0,0 +1,9 @@
+{
+    "endOfLine": "lf",
+    "semi": true,
+    "singleQuote": true,
+    "tabWidth": 4,
+    "arrowParens": "avoid",
+    "trailingComma": "all",
+    "useTabs": false
+}

.prettierrc.json

@@ -0,0 +1,27 @@
+{
+    "branches": ["main"],
+    "repositoryUrl": "https://github.com/steamicc/micropython-steami-lib.git",
+    "debug": false,
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/release-notes-generator",
+        [
+            "@semantic-release/changelog",
+            {
+                "changelogTitle": "# Changelog\n\nAll notable changes to this project will be documented in this file. See\n[Conventional Commits](https://conventionalcommits.org) for commit guidelines."
+            }
+        ],
+        [
+            "@semantic-release/github",
+            {
+                "assets": "pack/*.tgz"
+            }
+        ],
+        [
+            "@semantic-release/git",
+            {
+                "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+            }
+        ]
+    ]
+}

.releaserc.json

@@ -0,0 +1,4 @@
+module.exports = {
+    pattern: "^(main)$|^(feat|fix|docs|tooling|ci|test|style|chore|refactor)\/([a-z0-9]+-)*[a-z0-9]+$|^release\/v([0-9]+)\\.([0-9]+)\\.([0-9]+)([a-z0-9-]*)$",
+    errorMsg: "🤨 La branche que tu essaies de pusher ne respecte pas nos conventions, tu peux la renommer avec `git branch -m <nom-actuel> <nouveau-nom>`",
+}

.validate-branch-namerc.js

@@ -48,46 +48,46 @@ lib/<component>/
 
 ## Linting
 
-The project uses `ruff` for linting.
-
 ```bash
-ruff check .
+make lint
 ```
 
 To automatically fix issues:
 
 ```bash
-ruff check . --fix
+make lint-fix
 ```
 
 ## Commit messages
 
-Use the following format:
+Commit messages follow the [Conventional Commits](https://www.conventionalcommits.org/) format, enforced by commitlint via a git hook:
 
 ```
-<scope>: <Description starting with a capital letter ending with a period.>
+<type>[(<scope>)]: <Description starting with a capital letter ending with a period.>
 ```
 
-The scope is the driver name or domain (`hts221`, `ism330dl`, `docs`, `tests`, `ci`...). There is no predefined list of types — the scope is free-form.
+**Types**: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `ci`, `build`, `chore`, `perf`, `revert`, `tooling`
+
+**Scopes** (optional): driver names (`hts221`, `ism330dl`, `wsen-pads`...) or domains (`ci`, `docs`, `style`, `tests`, `tooling`). The scope is recommended for driver-specific changes but can be omitted for cross-cutting changes.
 
 ### Examples
 
 ```
-hts221: Fix missing self parameter in get_av method.
-ism330dl: Add driver support for temperature reading.
-wsen-pads: Correct pressure conversion formula.
+fix(hts221): Fix missing self parameter in get_av method.
+feat(ism330dl): Add driver support for temperature reading.
+fix(wsen-pads): Correct pressure conversion formula.
 docs: Update README driver table.
-tests: Add mock scenarios for mcp23009e driver.
+test(mcp23009e): Add mock scenarios for mcp23009e driver.
 ```
 
 ## Workflow
 
-1. Create a branch from main (`git checkout -b my-new-feature`)
-2. Write your code and add tests in `tests/scenarios/<driver>.yaml`
-3. Run `ruff check` and `python -m pytest tests/ -v -k mock locally`
-4. Commit your changes following the commit message format
-5. Push your branch to the repository
-6. Open a Pull Request
+1. Set up your environment: `make setup`
+2. Create a branch from main (format: `feat/`, `fix/`, `docs/`, `tooling/`, `ci/`, `test/`, `style/`, `chore/`, `refactor/`)
+3. Write your code and add tests in `tests/scenarios/<driver>.yaml`
+4. Run `make ci` to verify everything passes (lint + tests + examples)
+5. Commit — the git hooks will automatically check your commit message and run ruff on staged files
+6. Push your branch and open a Pull Request
 
 ## Continuous Integration
 
@@ -98,6 +98,7 @@ All pull requests must pass these checks:
 | Commit messages | `check-commits.yml` | Validates commit message format |
 | Linting | `python-linter.yml` | Runs `ruff check` |
 | Mock tests | `tests.yml` | Runs mock driver tests |
+| Example validation | `tests.yml` | Validates example files syntax and imports |
 
 ## Notes