build: Use of pre-commit

Author: Alan Christie

.cz.yaml

@@ -0,0 +1,48 @@
+---
+# Commitizen custom configuration.
+# Here we extend it to add all our recognised types into the changelog.
+# The default ignores pretty-much anything other than 'feat' and 'fix'.
+#
+# See the default at...
+# https://github.com/commitizen-tools/commitizen/
+#   blob/095f02e6c419b60c90aa84b8cebc9e9eacc8a391/commitizen/defaults.py#L83
+commitizen:
+  name: cz_customize
+  # What's the first revision we're interested imn?
+  # For us it's the revision we started using
+  # enforcing the use of conventional commits.
+  # Prior to 0.4.0 we weren't using it on every commit
+  # and didn't have everything ready for change-logs.
+  changelog_start_rev: 1.7.0
+  customize:
+    schema_pattern: "^(?P<change_type>feat|fix|perf|refactor|remove|style|test|build|docs|ci|BREAKING CHANGE)(?:\\((?P<scope>[^()\\r\\n]*)\\)|\\()?(?P<breaking>!)?:\\s(?P<message>.*)?"
+    commit_parser: "^(?P<change_type>feat|fix|perf|refactor|remove|style|test|build|docs|ci|BREAKING CHANGE)(?:\\((?P<scope>[^()\\r\\n]*)\\)|\\()?(?P<breaking>!)?:\\s(?P<message>.*)?"
+    # The changelog_pattern identifies the commit types
+    # that will be included.
+    # Build the changelog with 'cz ch' on the staging or production branches.
+    changelog_pattern: "^(feat|fix|perf|refactor|remove|style|test|build|docs|ci)?"
+    # A mapping of type to its group name in the changelog.
+    # We call 'feat' commits 'New Features'
+    change_type_map:
+      build: Build
+      docs: Documentation
+      feat: New Features
+      fix: Bug Fixes
+      perf: Performance Improvements
+      refactor: Refactoring
+      remove: Removed
+      style: Stylistic Changes
+      ci: CI/CD
+      test: Testing
+    # The order of commit types in the changelog...
+    change_type_order:
+    - "feat"
+    - "fix"
+    - "perf"
+    - "refactor"
+    - "remove"
+    - "style"
+    - "test"
+    - "build"
+    - "ci"
+    - "docs"

.github/workflows/build.yaml

@@ -42,13 +42,10 @@ jobs:
         python -m pip install --upgrade pip
         pip install -r requirements.txt
         pip install -r build-requirements.txt
-        pip install -r package-requirements.txt
     - name: Test
       run: |
+        pre-commit run --all-files
         pytest --cov=decoder
-        pyroma .
-        pylint decoder
-        mypy decoder --install-types --non-interactive
     - name: Build
       run: |
-        python setup.py bdist_wheel
+        python -m build --sdist --wheel --outdir dist/

.github/workflows/publish.yaml

@@ -40,11 +40,9 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -r build-requirements.txt
-        pip install -r package-requirements.txt
     - name: Build
       run: |
-        pyroma .
-        python setup.py bdist_wheel
+        python -m build --sdist --wheel --outdir dist/
     - name: Publish
       uses: pypa/gh-action-pypi-publish@release/v1
       with:

.pre-commit-config.yaml

@@ -0,0 +1,74 @@
+---
+minimum_pre_commit_version: 2.18.1
+
+repos:
+
+# commit-msg hooks
+# ----------
+
+# Conventional Commit message checker (commitizen)
+- repo: https://github.com/commitizen-tools/commitizen
+  rev: v2.23.0
+  hooks:
+  - id: commitizen
+    stages:
+    - commit-msg
+
+# pre-commit hooks
+# ----------
+
+# Standard pre-commit rules
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.1.0
+  hooks:
+  - id: check-case-conflict
+  - id: check-docstring-first
+  - id: check-executables-have-shebangs
+  - id: check-shebang-scripts-are-executable
+  - id: check-toml
+  - id: detect-private-key
+  - id: end-of-file-fixer
+  - id: requirements-txt-fixer
+  - id: trailing-whitespace
+    args:
+    - --markdown-linebreak-ext=md
+# Black (uncompromising) Python code formatter
+- repo: https://github.com/psf/black
+  rev: 22.3.0
+  hooks:
+  - id: black
+    args:
+    - --target-version
+    - py39
+# MyPy
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v0.942
+  hooks:
+  - id: mypy
+    files: ^decoder
+    args:
+    - --install-types
+    - --non-interactive
+# YAML Lint
+- repo: https://github.com/adrienverge/yamllint
+  rev: v1.26.3
+  hooks:
+  - id: yamllint
+# Pyroma
+- repo: https://github.com/regebro/pyroma
+  rev: "4.0"
+  hooks:
+  - id: pyroma
+
+# Local hooks (requires a suitable env)
+# -----
+# The following expect 'pip install -r requirements.txt'
+
+# Pylint
+- repo: local
+  hooks:
+  - id: pylint
+    name: pylint
+    entry: pylint
+    language: system
+    files: ^decoder/.*\.py$

.yamllint

@@ -0,0 +1,40 @@
+---
+
+yaml-files:
+- '*.yaml'
+- '*.yml'
+- '.yamllint'
+
+ignore: |
+  .github/
+
+rules:
+  indentation:
+    spaces: 2
+    indent-sequences: no
+  trailing-spaces: {}
+  truthy:
+    allowed-values:
+    - 'yes'
+    - 'no'
+    - 'true'
+    - 'false'
+  new-lines:
+    type: unix
+  new-line-at-end-of-file: enable
+  key-duplicates: {}
+  hyphens:
+    max-spaces-after: 1
+  empty-lines:
+    max: 2
+  document-start:
+    present: yes
+  document-end:
+    present: no
+  colons:
+    max-spaces-before: 0
+    max-spaces-after: 1
+  commas:
+    max-spaces-before: 0
+    min-spaces-after: 1
+    max-spaces-after: 1

build-requirements.txt

@@ -1,5 +1,4 @@
-pylint
-pyroma
-pytest
-pytest-cov
-mypy
+black == 22.3.0
+pre-commit == 2.18.1
+pytest == 7.1.1
+pytest-cov == 3.0.0

requirements.txt

@@ -1,3 +1,3 @@
-jsonschema == 3.2.0
 jinja2 == 3.0.3
+jsonschema == 3.2.0
 pyyaml == 5.4.1