ci: add github action and workflow to check pr title for commit message format (#377) (#380)

Author: hunterckx

.github/actions/check-input-commit-message/action.yml

@@ -0,0 +1,9 @@
+name: Check input commit message
+description: Check an input string for Conventional Commits format and issue number
+inputs:
+  message:
+    description: String to check as a commit message
+    required: true
+runs:
+  using: "node20"
+  main: "index.js"

.github/actions/check-input-commit-message/index.js

@@ -0,0 +1,47 @@
+const core = require("@actions/core");
+
+async function runCommitlint(message) {
+  const { default: load } = await import("@commitlint/load");
+  const { default: lint } = await import("@commitlint/lint");
+  const { default: format } = await import("@commitlint/format");
+
+  console.log("Checking for Conventional Commits format");
+
+  const config = await load();
+  const report = await lint(message, config.rules, {
+    parserOpts: config.parserPreset?.parserOpts,
+  });
+  const reportMessage = format({ results: [report] }, { verbose: true });
+
+  if (report.valid) console.log(reportMessage + "\n");
+  else console.error(reportMessage + "\n");
+
+  return report.valid;
+}
+
+function checkIssueNumber(message) {
+  console.log(
+    "Checking for a '#xxx' reference to a corresponding GitHub issue"
+  );
+  if (/#[0-9]/.test(message)) {
+    console.log("Successfully found issue number\n");
+    return true;
+  } else {
+    console.error("Issue number missing\n");
+    return false;
+  }
+}
+
+async function checkMessage() {
+  const message = core.getInput("message");
+  const failedChecks = [];
+  if (!checkIssueNumber(message)) failedChecks.push("issue number");
+  if (!(await runCommitlint(message)))
+    failedChecks.push("Conventional Commits");
+  if (failedChecks.length > 0)
+    core.setFailed(
+      `Failed ${failedChecks.join(" and ")} check${failedChecks.length > 1 ? "s" : ""}`
+    );
+}
+
+checkMessage().catch((e) => core.setFailed(e.message));

.github/workflows/check-pr-title.yml

@@ -0,0 +1,24 @@
+name: Check pull request title
+on:
+  pull_request:
+    types: [edited, opened, synchronize, reopened]
+
+jobs:
+  check-pr-title:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+      - name: Cache npm cache
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}
+      - name: Install dependencies
+        run: npm ci
+      - name: Check pull request title for Conventional Commits format and GitHub issue number
+        uses: ./.github/actions/check-input-commit-message
+        with:
+          message: ${{ github.event.pull_request.title }}