Repository navigation
ci: open a changelog PR instead of pushing to main - #113
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
The release workflow publishes to npm and creates the GitHub Release, then tried to commit the regenerated CHANGELOG.md directly to main. main's branch ruleset (required status checks) declines that push with GH013, which marked otherwise-successful releases as failed (e.g. v2.10.0, v2.11.0). Instead, open a PR against main with the changelog change via peter-evans/create-pull-request. This respects the ruleset, keeps the release job green, and still lands the changelog on main once merged. Requires the repo setting "Allow GitHub Actions to create and approve pull requests" (Settings -> Actions -> General) to be enabled.
KevinEdry
force-pushed
the
ci/changelog-push-nonfatal
branch
from
June 18, 2026 18:44
4fba7a8 to
77b3d8c
Compare
KevinEdry
changed the title
This branch was successfully deployed
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.
Problem
The release workflow succeeds at the important steps — publish to npm and create the GitHub Release — but then tries to commit the regenerated
CHANGELOG.mddirectly tomain.main's branch ruleset declines that push:So otherwise-successful releases (v2.10.0, v2.11.0) get marked failed on the very last step, after the package is already live.
Fix
Instead of pushing to
main, open a PR with the changelog change usingpeter-evans/create-pull-request(branchchangelog/v<version>, scoped toCHANGELOG.md). This respects the ruleset, keeps the release job green, and still lands the changelog onmainonce the PR's checks pass and it's merged.Also adds
pull-requests: writeto thepublishjob permissions.For the workflow's
GITHUB_TOKENto open PRs, enable:Settings → Actions → General → Workflow permissions → "Allow GitHub Actions to create and approve pull requests"
Without it, the step will fail with a 403.