ci: detect breaking-change commits in PRs#350
Open
MarioCadenas wants to merge 1 commit intomainfrom
Open
Conversation
atilafassina
approved these changes
May 6, 2026
MarioCadenas
force-pushed
the
ci/pr-breaking-change-check
branch
from
0de2b5f to
fe49bf2
Compare
Adds a workflow that scans every commit in a pull request for Conventional Commits breaking-change markers (`type!:` or `BREAKING CHANGE:` footer) limited to the packages tracked by .release-it.json (appkit, appkit-ui, shared). When a breaking commit is found, the job posts a sticky PR comment explaining the major-version impact and fails the check, unless the PR carries an `allow-breaking-change` label. This prevents accidental major bumps from landing on main once the new check is added to branch-protection required checks. Signed-off-by: MarioCadenas <[email protected]>
MarioCadenas
force-pushed
the
ci/pr-breaking-change-check
branch
from
fe49bf2 to
85f7249
Compare
pkosiec
reviewed
May 6, 2026
Member
There was a problem hiding this comment.
Maybe we can keep it within the same workflow (but as a separate job) as the PR title check?
Let's call it PR metadata verification or similar 🤔
pkosiec
reviewed
May 6, 2026
Member
There was a problem hiding this comment.
consider using ts/js for that, to be consistent with the tools 🤔
But primarily, do we need that? We squash those commits so maybe we should enforce e.g. empty PR description?
Collaborator
Author
There was a problem hiding this comment.
we could also do that, that wouldn't cover the case for feat!: ... is the only thing
Member
There was a problem hiding this comment.
gotcha, so the script is useful - do you mind to unify it with other tools to use ts?
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
3 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
.github/workflows/pr-breaking-change.yml, a workflow that scans every commit in a PR for Conventional Commits breaking-change markers and gates the merge.git rev-list base..headover the paths tracked by.release-it.json(packages/appkit,packages/appkit-ui,packages/shared) so docs/tooling-only commits don't trigger noise.feat!:,feat(scope)!:, etc. across all conventional types) andBREAKING CHANGE:/BREAKING-CHANGE:footers.actions/[email protected](identified by an HTML-comment marker so re-runs update/remove the same comment).allow-breaking-changelabel, providing an explicit escape hatch for intentional major bumps.Today,
.release-it.jsonhasbumpStrict: true, so a singleBREAKING CHANGE:orfeat!commit landing onmainsilently forces a major version on the next release. This check makes that visible at PR time.Follow-ups (not in this PR)
PR Breaking Change Check / Detect Breaking Commitsto the required status checks for themainbranch protection rule. Without that, the comment will appear but the merge button is not blocked.allow-breaking-changelabel so reviewers can opt in when a major bump is intentional.mainis configured for squash merge, the per-commit messages are discarded on merge andrelease-itonly sees the squash commit (already covered bypr-title.yml); in that case this check is informational. With merge commit or rebase merge strategies, the check is load-bearing.Test plan
feat(appkit)!: test breaking markertouchingpackages/appkit/**and verify:allow-breaking-changelabel re-runs the workflow and turns it green; comment updates to acknowledge the intentional bump.feat!:touchingdocs/**only and confirm the check stays green (path filter working).