Skip to content

fix: prepend the dependabot breaking-change note so majors trigger a major release #1963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jeswr wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix: prepend the dependabot breaking-change note so majors trigger a major release #1963

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions .github/workflows/automerge.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,20 @@ jobs:
steps.metadata.outputs.update-type == 'version-update:semver-major'
run: |
gh pr view "$PR_URL" --json body --jq .body > body.md
# Guard so re-runs (e.g. on synchronize) do not append the footer twice
# Guard so re-runs (e.g. on synchronize) do not add the note twice
if ! grep -q '^BREAKING CHANGE:' body.md; then
printf '\n\nBREAKING CHANGE: %s updated from %s to %s (new major version). This update may contain breaking changes.\n' \
"$DEPENDENCY_NAMES" "$PREVIOUS_VERSION" "$NEW_VERSION" >> body.md
gh pr edit "$PR_URL" --body-file body.md
# The note MUST be prepended, not appended: the conventional-commits
# parser stops treating a "BREAKING CHANGE:" line as a footer note once
# a Markdown thematic break ("---", which dependabot always includes)
# sits between it and the header, so a trailing note is silently ignored
# and the release stays a patch. Putting it in the first paragraph makes
# the squashed commit resolve to a major release.
{
printf 'BREAKING CHANGE: %s updated from %s to %s (new major version). This update may contain breaking changes.\n\n' \
"$DEPENDENCY_NAMES" "$PREVIOUS_VERSION" "$NEW_VERSION"
cat body.md
} > body.new.md
gh pr edit "$PR_URL" --body-file body.new.md
fi
env:
PR_URL: ${{ github.event.pull_request.html_url }}
Expand Down
Loading