Merge pull request #794 from XeroAPI/conventional-commit

Enforce conventional commit formatting

Author: the-chris-mitchell

.commitlintrc.json

@@ -0,0 +1,7 @@
+{
+  "extends": ["@commitlint/config-conventional"],
+  "rules": {
+    "subject-case": [0],
+    "body-max-line-length": [0]
+  }
+}

.github/workflows/create-github-release.yml

@@ -31,6 +31,6 @@ jobs:
           node-version: 20
 
       - name: Perform release
-        run: npx --package @semantic-release/exec semantic-release
+        run: npx --package @semantic-release/exec --package conventional-changelog-conventionalcommits semantic-release
         env:
           GH_TOKEN: ${{ steps.get_access_token.outputs.token }}

.github/workflows/pr-linting.yml

@@ -1,5 +1,8 @@
 name: PR Linting
 
+permissions:
+  contents: read
+
 on:
   pull_request:
     types: [opened, reopened, synchronize]
@@ -13,4 +16,23 @@ jobs:
         uses: actions/checkout@v4
 
       - name: MegaLinter
-        uses: oxsecurity/megalinter/flavors/documentation@v9
+        uses: oxsecurity/megalinter/flavors/documentation@v9
+
+  commitlint:
+    runs-on: ubuntu-latest
+    name: Conventional Commit Validation
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Validate PR commits with commitlint
+        run: |
+          npm install --no-save @commitlint/cli @commitlint/config-conventional
+          npx commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose

.releaserc

@@ -21,6 +21,11 @@
       }
     ],
     "@semantic-release/github",
-    "@semantic-release/commit-analyzer"
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "preset": "conventionalcommits"
+      }
+    ]
   ]
 }