build: use commitlint to enforce conventional commits

.commitlintrc.js

@@ -0,0 +1,13 @@
+import { RuleConfigSeverity } from "@commitlint/types";
+
+/**
+ * @type {import('@commitlint/types').UserConfig}
+ */
+const Configuration = {
+  extends: ["@commitlint/config-conventional"],
+  rules: {
+    "body-max-line-length": [RuleConfigSeverity.Error, "always", 200],
+  },
+};
+
+export default Configuration;

.github/dependabot.yml

@@ -8,3 +8,12 @@ updates:
     directory: endToEndTests/
     schedule:
       interval: weekly
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      minorAndPatch:
+        update-types:
+          - "minor"
+          - "patch"

.github/workflows/commitlint.yml

@@ -0,0 +1,30 @@
+name: Commitlint
+
+on:
+  pull_request:
+    types:
+      - ready_for_review
+
+jobs:
+  commitlint:
+    name: Lint commit messages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+
+      - uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}
+
+      - name: Install npm packages
+        run: npm ci
+
+      - name: Validate PR commits with commitlint
+        run: npx commitlint --from ${{ github.event.pull_request.base.sha }} --verbose

.gitignore

@@ -66,3 +66,5 @@ conanprofile
 **/output/
 **/logs/
 **/temp/
+
+**/node_modules/

README.md

@@ -183,3 +183,17 @@ The includes are sorted in the following order:
 4. Internal includes
 
 Internal includes are marked by double quotes. External includes are marked by angle brackets.
+
+## Conventional Commits
+
+We follow the [conventional commits](https://www.conventionalcommits.org/) guidelines for commit messages.
+This will allow to automatically generate a changelog.
+
+We use [commitlint](https://commitlint.js.org/) to enforce the commit message format.
+To use it locally, run `npm install`.
+
+The last commit message can be checked with 
+
+```shell
+npm run commitlint:last-commit
+```