Repository navigation
ci: check commit messages and the PR description against the team message standard - #414
Merged
Merged
Conversation
🔍 Cora AI Code Review✅ No issues found. Code looks good! Review powered by cora-code · BYOK · MIT |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
A new Message Standard job in PR Checks: it fails a PR when any of its commit messages, or its description, carries a line the team message standard does not allow.
Why
A squash merge can carry lines from the branch's commits into develop even when the PR description itself is clean, and once that happens it cannot be undone without rewriting shared history. Catching it on the PR is the only reliable point.
Changes
.github/workflows/pr-checks.yml:message-standardjob (bot PRs exempt like the other checks). It reads every commit message of the PR through the API plus the PR description and matches them against the pattern in the repository variableMESSAGE_STANDARD_PATTERN. An unset variable or an invalid pattern fails the job loudly instead of passing silently (grep's error status is not read as "no match").Testing
bash -eo pipefail) for five cases: clean (pass), disallowed commit trailer (fail), disallowed description line (fail), invalid pattern (fail loudly), unset variable (fail loudly).