feat: Experiment with CI and build

Author: Alan Christie

.cz.yaml

@@ -0,0 +1,43 @@
+---
+# 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
+  customize:
+    schema_pattern: "^(?P<change_type>feat|fix|perf|refactor|remove|style|test|build|docs|chore|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|chore|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|chore|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"
+    - "chore"
+    - "ci"
+    - "docs"

.github/workflows/build.yaml

@@ -0,0 +1,56 @@
+---
+name: build
+
+# -----------------
+# Control variables (GitHub Secrets)
+# -----------------
+#
+# At the GitHub 'organisation' or 'project' level you must have the following
+# GitHub 'Repository Secrets' defined (i.e. via 'Settings -> Secrets'): -
+#
+# (none)
+#
+# -----------
+# Environment (GitHub Environments)
+# -----------
+#
+# Environment         (none)
+
+on:
+  push:
+    branches:
+    - '**'
+    tags-ignore:
+    - '**'
+  schedule:
+  # Build daily at 6:04am...
+  - cron: '4 6 * * *'
+
+env:
+  POETRY_VERSION: '1.8.3'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+        - '3.12'
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install requirements
+      run: |
+        python -m pip install --upgrade pip
+        pip install --no-cache-dir poetry==$POETRY_VERSION
+        poetry install --with dev --no-root --no-directory
+    - name: Test
+      run: |
+        pre-commit run --all-files
+    - name: Build
+      run: |
+        poetry build

.pre-commit-config.yaml

@@ -65,4 +65,4 @@ repos:
     - jinja2==3.0.3
     - jsonschema >= 3.2.0, < 4.0
     - pyyaml >= 5.3.1, < 7.0
-    files: ^workflow/.*\.py$
+    files: ^workflow/.*\.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

README.rst

@@ -36,4 +36,4 @@ Get in touch
 
 - Report bugs, suggest features or view the source code `on GitHub`_.
 
-.. _on GitHub: https://github.com/informaticsmatters/squonk2-data-manager-workflow-decoder
+.. _on GitHub: https://github.com/informaticsmatters/squonk2-data-manager-workflow-decoder

poetry.lock

@@ -13,6 +13,9 @@ python = "^3.12"
 jsonschema = "^4.21.1"
 pyyaml = ">= 5.3.1, < 7.0"
 
+[tool.poetry.group.dev.dependencies]
+pre-commit = "^3.7.0"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -2,6 +2,7 @@
 
 This is typically used by the Data Manager's Workflow Engine.
 """
+
 import os
 from typing import Any, Dict, Optional