{workflows/lint,ci/github-script}: lint commit messages

2025-12-13 16:43:41 -05:00
parent a5bcf23041
commit 7cf5972410
3 changed files with 123 additions and 0 deletions
@@ -0,0 +1,90 @@
+// @ts-check
+const { classify } = require('../supportedBranches.js')
+
+/**
+ * @param {{
+ *  github: InstanceType<import('@actions/github/lib/utils').GitHub>,
+ *  context: import('@actions/github/lib/context').Context
+ *  core: import('@actions/core')
+ * }} CheckCommitMessagesProps
+ */
+async function checkCommitMessages({ github, context, core }) {
+  // Do not run on merge groups: it'd be much harder, and there is no need
+  // (changes to the target branch can't change commit messages on the base branch).
+  const pull_number = context.payload.pull_request?.number
+  if (!pull_number) {
+    core.info('This is not a pull request. Skipping checks.')
+    return
+  }
+
+  const pr = (
+    await github.rest.pulls.get({
+      ...context.repo,
+      pull_number,
+    })
+  ).data
+
+  const baseBranchType = classify(
+    pr.base.ref.replace(/^refs\/heads\//, ''),
+  ).type
+  const headBranchType = classify(
+    pr.head.ref.replace(/^refs\/heads\//, ''),
+  ).type
+
+  if (
+    baseBranchType.includes('development') &&
+    headBranchType.includes('development')
+  ) {
+    // This matches, for example, PRs from staging-next to master, or vice versa.
+    // Ignore them: we should only care about PRs introducing *new* commits.
+    core.info(
+      'This PR is from one development branch to another. Skipping checks.',
+    )
+    return
+  }
+
+  const commits = await github.paginate(github.rest.pulls.listCommits, {
+    ...context.repo,
+    pull_number,
+  })
+
+  const failures = new Set()
+
+  for (const commit of commits) {
+    const message = commit.commit.message
+    const firstLine = message.split('\n')[0]
+
+    const logMsgStart = `Commit ${commit.sha}'s message's subject ("${firstLine}")`
+
+    if (!firstLine.includes(':')) {
+      core.error(
+        `${logMsgStart} was detected as not meeting our guidelines because ` +
+          'it does not contain a colon. There are likely other issues as well.',
+      )
+      failures.add(commit.sha)
+    }
+
+    if (firstLine.endsWith('.')) {
+      core.error(
+        `${logMsgStart} was detected as not meeting our guidelines because ` +
+          'it ends in a period. There may be other issues as well.',
+      )
+      failures.add(commit.sha)
+    }
+
+    if (!failures.has(commit.sha)) {
+      core.info(`${logMsgStart} passed our automated checks!`)
+    }
+  }
+
+  if (failures.size !== 0) {
+    core.error(
+      'Please review the guidelines at ' +
+        'https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#commit-conventions, ' +
+        'as well as the applicable area-specific guidelines linked there.',
+    )
+    core.setFailed('Committers: merging is discouraged.')
+  }
+}
+
+module.exports = checkCommitMessages
@@ -94,4 +94,15 @@ program
    await run(getTeams, owner, repo, undefined, { ...options, outFile })
  })

+program
+  .command('lint-commits')
+  .description('Lint for common errors in commit messages')
+  .argument('<owner>', 'Owner of the GitHub repository to run on (Example: NixOS)')
+  .argument('<repo>', 'Name of the GitHub repository to run on (Example: nixpkgs)')
+  .argument('<pr>', 'Number of the Pull Request to run on')
+  .action(async (owner, repo, pr, options) => {
+    const checkCommitMessages = (await import('./lint-commits.js')).default
+    await run(checkCommitMessages, owner, repo, pr, options)
+  })
+
 await program.parse()