Migrate JIRA actions to own repo

.github/workflows/dangerjs.yml

@@ -0,0 +1,24 @@
+name: DangerJS Pull Request linter
+on:
+  pull_request_target:
+    types: [opened, edited, reopened, synchronize]
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  pull-request-style-linter:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out PR head
+      uses: actions/checkout@v4
+      with:
+        ref: ${{ github.event.pull_request.head.sha }}
+
+    - name: DangerJS pull request linter
+      uses: espressif/shared-github-dangerjs@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        instructions-contributions-file: 'CONTRIBUTING.md'

.github/workflows/pre-commit.yml

@@ -0,0 +1,16 @@
+name: Check pre-commit
+
+on:
+  pull_request:
+
+jobs:
+  check-pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+      - uses: pre-commit/[email protected]
+        env:
+          SKIP: pip-compile

.github/workflows/python-test.yml

@@ -0,0 +1,25 @@
+name: Tests
+
+on:
+  pull_request:
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.11
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest pytest-cov
+        pip install -r requirements.txt
+
+    - name: Run pytest with coverage
+      run: |
+        python -m pytest

.gitignore

@@ -0,0 +1,109 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# cache
+.mypy_cache/
+.ruff_cache/
+__pycache__/*
+
+# Generated by setuptools-scm when using pip install -e
+version.py

.pre-commit-config.yaml

@@ -0,0 +1,69 @@
+# Run `pre-commit autoupdate` to update to the latest pre-commit hooks version.
+# When changing the version of tools that are also installed as development dependencies (e.g., black, mypy, ruff),
+#  please ensure the same versions are pinned in this file as in `pyproject.toml`.
+---
+minimum_pre_commit_version: 3.3.0 # Specifies the minimum version of pre-commit required for this configuration
+default_install_hook_types: [pre-commit, commit-msg] # Default hook types to install if not specified in individual hooks
+default_stages: [pre-commit]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace # Removes trailing whitespaces from lines
+      - id: end-of-file-fixer # Ensures files end with a newline
+      - id: check-executables-have-shebangs # Checks executables have a proper shebang
+      - id: mixed-line-ending # Detects mixed line endings (CRLF/LF)
+        args: ['-f=lf'] # Forces files to use LF line endings
+      - id: double-quote-string-fixer # Converts single quotes to double quotes in strings
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.2.1
+    hooks:
+      - id: ruff # Runs ruff linter (replaces flake8)
+        args: [--fix, --exit-non-zero-on-fix]
+
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.12.0
+    hooks:
+      - id: reorder-python-imports # Reorders Python imports to a standard format (replaces isort)
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy # Runs mypy for Python type checking
+        additional_dependencies: ['types-all']
+
+  - repo: https://github.com/espressif/conventional-precommit-linter
+    rev: v1.6.0
+    hooks:
+      - id: conventional-precommit-linter # Lints commit messages for conventional format
+        stages: [commit-msg]
+
+  - repo: https://github.com/psf/black
+    rev: '24.1.1'
+    hooks:
+      - id: black # Formats Python code using black
+
+  - repo: https://github.com/pylint-dev/pylint
+    rev: v3.0.3
+    hooks:
+      - id: pylint # Runs pylint on Python code
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell # Code spell checker
+        args: ["--write-changes"]
+        additional_dependencies: [tomli]
+
+
+  # Local hooks
+  - repo: local
+    hooks:
+      - id: pip-compile
+        name: compile requirements.txt
+        entry: bash -c 'pip-compile --output-file=requirements.txt pyproject.toml > /dev/null'
+        language: system
+        pass_filenames: false
+        files: requirements.txt|pyproject.toml

CONTRIBUTING.md

@@ -0,0 +1,79 @@
+We welcome contributions! To contribute to this repository, please read these instructions:
+
+- [Project Organization](#project-organization)
+- [Code and Testing](#code-and-testing)
+- [Documentation and Maintenance](#documentation-and-maintenance)
+- [Development and Local Testing](#development-and-local-testing)
+
+---
+
+## Project Organization
+
+- **Project Configuration:** The setup for both production and development dependencies is outlined in the `pyproject.toml` file. This centralized approach simplifies dependency management.
+
+- **Automatic `requirements.txt`:** Changes to dependencies are automatically reflected in the `requirements.txt` file, derived from `pyproject.toml`. Direct modifications should be avoided; instead, update `pyproject.toml`.
+
+- **Commit Standard:** Adherence to the Espressif standard for Conventional Commits ensures consistency in commit messages. Tools like pre-commit hooks and the integrated PR linter DangerJS assist in formatting commit messages appropriately, a key factor for `commitizen` to auto-generate the changelog.
+
+## Code and Testing
+
+- **Code Style and Structure:**
+
+  - **Pre-Commit Hooks:** Install pre-commit hooks in this repository using the `pre-commit install` command.
+
+  - **Readable Code Structure:** Structure your code in a readable manner. The main logic should be in the default rule function, with implementation details in helper functions. Avoid nested `if` statements and unnecessary `else` statements to maintain code clarity and simplicity.
+
+  - **Remove Debug Statements:** Remove any development debug statements from your files.
+
+- **Automated Tests:** The tests should cover all typical usage scenarios as well as edge cases to ensure robustness.
+
+- **Testing Tool:** It is recommended to run `pytest` frequently during development to ensure that all aspects of your code are functioning as expected.
+
+## Documentation and Maintenance
+
+- **Changelog:** `CHANGELOG.md` is generated automatically by `commitizen` from commit messages. Not need to update `CHANGELOG.md` manually. Focus on informative and clear commit messages which end in the release notes.
+
+- **Documentation:** Regularly check and update the documentation to keep it current.
+
+- **PR Descriptions and Documentation:** When contributing, describe all changes or new features in the PR (Pull Request) description as well as in the documentation. When changing the style to the output style, attach a thumbnail after the change.
+
+## Development and Local Testing
+
+1. **Clone the Project**
+
+- Clone the repository to your local machine using:
+
+  ```sh
+  git clone <project_clone_url>
+  ```
+
+2. **Set Up Development Environment:**
+
+- Create and activate a virtual environment:
+
+  ```sh
+  python -m venv venv && source ./venv/bin/activate
+  ```
+
+  or:
+
+  ```sh
+  virtualenv venv && source ./venv/bin/activate
+  ```
+
+- Install the project and development dependencies:
+  ```sh
+  pip install -e '.[dev]'
+  ```
+
+3. **Testing Your Changes:**
+
+- Before submitting a pull request, ensure your changes pass all the tests. You can run the test suite with the following command:
+
+```sh
+pytest
+```
+
+---
+
+👏**Thank you for your contributions.**