ci: commitlint integration

.commitlintrc.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };

.github/workflows/commitlint.yml

@@ -0,0 +1,28 @@
+name: CommitLint
+concurrency:
+  cancel-in-progress: true
+  group: ${{ github.workflow }}-${{ github.ref }}
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: env | sort
+      - name: Install commitlint with conventional config
+        run: npm install --save-dev @commitlint/config-conventional @commitlint/cli
+      - name: Validate the latest commit message with commitlint
+        if: github.event_name == 'push'
+        run: echo "${{ github.event.head_commit.message }}" | npx commitlint
+      - name: Validate pull request title with commitlint
+        if: github.event_name == 'pull_request'
+        run: echo "${{ github.event.pull_request.title }}" | npx commitlint
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - edited
+  push:
+    branches:
+      - main

.gitlab/workflows/commitlint.yml

@@ -0,0 +1,16 @@
+commitlint:
+  image:
+    name: commitlint/commitlint:latest
+    entrypoint: [""]
+  interruptible: true
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
+  script:
+    - |
+      if [ "$CI_PIPELINE_SOURCE" = "push" ]; then
+        echo "$CI_COMMIT_TITLE" | commitlint
+      elif [ "$CI_PIPELINE_SOURCE" = "merge_request_event" ]; then
+        echo "$CI_MERGE_REQUEST_TITLE" | commitlint
+      fi
+  stage: ci

.vscode/settings.json

@@ -20,6 +20,7 @@
     "autofix",
     "automodule",
     "cobertura",
+    "commitlint",
     "deepclean",
     "deflist",
     "devcontainer",
@@ -35,6 +36,7 @@
     "maxdepth",
     "modindex",
     "mypy",
+    "noninteractive",
     "pathjoin",
     "pipenv",
     "pipx",
@@ -151,7 +153,7 @@
   ],
   "vscode-yaml-sort.noCompatMode": true,
   "vscode-yaml-sort.sortOnSave": 2,
-  "vscode-yaml-sort.useArrayProcessor": false,
+  "vscode-yaml-sort.useArrayProcessor": true,
   "vscode-yaml-sort.useBlockProcessor": false,
   "vscode-yaml-sort.useCustomSortRecursively": true,
   "vscode-yaml-sort.useHelmProcessor": false,

template/.commitlintrc.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };

template/.vscode/settings.json

@@ -20,6 +20,7 @@
     "autofix",
     "automodule",
     "cobertura",
+    "commitlint",
     "deepclean",
     "deflist",
     "devcontainer",
@@ -35,6 +36,7 @@
     "maxdepth",
     "modindex",
     "mypy",
+    "noninteractive",
     "pathjoin",
     "pipenv",
     "pipx",
@@ -151,7 +153,7 @@
   ],
   "vscode-yaml-sort.noCompatMode": true,
   "vscode-yaml-sort.sortOnSave": 2,
-  "vscode-yaml-sort.useArrayProcessor": false,
+  "vscode-yaml-sort.useArrayProcessor": true,
   "vscode-yaml-sort.useBlockProcessor": false,
   "vscode-yaml-sort.useCustomSortRecursively": true,
   "vscode-yaml-sort.useHelmProcessor": false,

template/[% if repo_host_type == 'github.com' %].github[% endif %]/workflows/commitlint.yml

@@ -0,0 +1,28 @@
+name: CommitLint
+concurrency:
+  cancel-in-progress: true
+  group: ${{ github.workflow }}-${{ github.ref }}
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: env | sort
+      - name: Install commitlint with conventional config
+        run: npm install --save-dev @commitlint/config-conventional @commitlint/cli
+      - name: Validate the latest commit message with commitlint
+        if: github.event_name == 'push'
+        run: echo "${{ github.event.head_commit.message }}" | npx commitlint
+      - name: Validate pull request title with commitlint
+        if: github.event_name == 'pull_request'
+        run: echo "${{ github.event.pull_request.title }}" | npx commitlint
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - edited
+  push:
+    branches:
+      - main

template/[% if repo_host_type == 'gitlab.com' or repo_host_type == 'gitlab-self-managed' %].gitlab[% endif %]/workflows/commitlint.yml

@@ -0,0 +1,16 @@
+commitlint:
+  image:
+    name: commitlint/commitlint:latest
+    entrypoint: [""]
+  interruptible: true
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
+  script:
+    - |
+      if [ "$CI_PIPELINE_SOURCE" = "push" ]; then
+        echo "$CI_COMMIT_TITLE" | commitlint
+      elif [ "$CI_PIPELINE_SOURCE" = "merge_request_event" ]; then
+        echo "$CI_MERGE_REQUEST_TITLE" | commitlint
+      fi
+  stage: ci