ci: lint pull-request titles against Conventional Commits#461
Open
larsgeorge-db wants to merge 2 commits into
Open
ci: lint pull-request titles against Conventional Commits#461larsgeorge-db wants to merge 2 commits into
larsgeorge-db wants to merge 2 commits into
Conversation
larsgeorge-db
force-pushed
the
ci-pr-title-lint
branch
from
264a956 to
52bcaf3
Compare
will-yuponce-db
previously approved these changes
May 29, 2026
Contributor
will-yuponce-db
left a comment
will-yuponce-db
left a comment
There was a problem hiding this comment.
Approved! Feel free to merge upon CI passing
Contributor
Looks like you'll need to pin the SHA first |
larsgeorge-db
added a commit
that referenced
this pull request
May 29, 2026
Addresses review feedback on #461: every other third-party action in this repo is pinned to a full commit SHA with a trailing `# vX.Y.Z` comment (see .github/workflows/test-coverage.yml). The floating `@v5` tag bypassed that convention. Pinned to 0723387faaf9b38adef4775cd42cfd5155ed6017 (v5.5.3), the current latest in the v5 line.
Adds a `pull_request` workflow that runs amannn/action-semantic-pull-request@v5 on every PR open/edit/sync/reopen and rejects titles that don't parse as `type(scope): description` per the type table in CONTRIBUTING.md (feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert). Subject must start with a lowercase letter, matching the existing 95% of merged PRs. Scope is optional (CONTRIBUTING.md lists recommended scopes but does not enforce them). Squash-merge inherits the PR title as the commit message, so this keeps the commit log clean for downstream changelog/release tooling without touching merged history. Pairs with the issue-title normalization done separately; together, issues use `[Type]: Sentence-case` and PRs/commits use Conventional Commits, which are intentionally different conventions for different artifacts.
Addresses review feedback on #461: every other third-party action in this repo is pinned to a full commit SHA with a trailing `# vX.Y.Z` comment (see .github/workflows/test-coverage.yml). The floating `@v5` tag bypassed that convention. Pinned to 0723387faaf9b38adef4775cd42cfd5155ed6017 (v5.5.3), the current latest in the v5 line.
larsgeorge-db
force-pushed
the
ci-pr-title-lint
branch
from
51df06d to
aa2a336
Compare
Collaborator
Author
|
Pushed the update with the pinned version. Please review again @will-yuponce-db |
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
2 participants
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.
Summary
Adds a lightweight CI check that lints PR titles against Conventional Commits, using
amannn/action-semantic-pull-request@v5.feat,fix,docs,style,refactor,perf,test,build,ci,chore,revert.Feature/ontos approval workflows ux.Why
PR titles become squash-merge commit messages. Keeping them strictly Conventional Commits means the commit log stays clean for any future release-please / semantic-release / conventional-changelog tooling. This codifies what's already documented in
CONTRIBUTING.mdand practiced by contributors today; the workflow just prevents drift.Pairs with the recently-completed issue-title normalization. After both changes:
[Type]: Sentence-case description(human-readable, mixed audience)type(scope): description(machine-parseable, drives changelog tooling)These are intentionally different conventions for different artifacts.
Files
.github/workflows/pr-title-lint.yml— the new workflow. Runs onpull_request: [opened, edited, synchronize, reopened], read-only permissions.Test plan
Add cool thing) and verify the check fails with a helpful error.