Skip to content

The release changelog is uploaded, not pushed to main - #14

Merged
Hawkynt merged 5 commits into
mainfrom
fix/release-changelog-via-pr
Aug 29, 2026
Merged

Hawkynt merged 5 commits into
mainfrom
fix/release-changelog-via-pr

Conversation

@Hawkynt

@Hawkynt Hawkynt commented Aug 28, 2026 •

Copy link
Copy Markdown
Owner

main takes changes through pull requests only, so the release job cannot keep committing CHANGELOG.md straight to it.

A bot pull request is not the answer either. Measured, not assumed: a probe put an unsigned commit — authored and committed by the owner, so the unattributed-changes rule cannot apply — behind two green required checks, and the pull request stayed blocked. required_signatures is evaluated over a pull request's commits and a squash merge does not launder it. So a bot pull request needs a signed commit through the contents API and a personal access token before its own checks will run — for a file the dated GitHub Release already states in full.

What changed

  • CHANGELOG.md is uploaded as the changelog artifact. Commit it when you want the committed copy refreshed.
  • The release job drops pull-requests: write.
  • The release marker tags the commit the packages were actually built and published from. It used to move to the changelog commit — a commit containing none of the released code. That was wrong before this change and is impossible after it.

@Hawkynt
Hawkynt force-pushed the fix/release-changelog-via-pr branch 2 times, most recently from 2b81303 to 25f139b Compare August 29, 2026 03:13
@Hawkynt Hawkynt changed the title The release changelog is proposed as a pull request, not pushed to main The release changelog is uploaded, not pushed to main Aug 29, 2026
…main

main is about to take changes through pull requests only, and GitHub does not allow the Actions integration as a ruleset bypass actor on a personal-account repository, so this job cannot keep pushing.

The release marker now tags the commit the packages were actually built and published from. It used to move to the changelog commit — a commit that contains none of the released code — which was wrong before this change and is simply no longer possible after it.

CHANGELOG_PR_TOKEN is optional. Nothing done with GITHUB_TOKEN can trigger another workflow, so a pull request opened with it arrives with no checks and cannot satisfy a required-checks rule; with a personal access token carrying contents and pull-requests write, the pull request behaves like any other.
… action

A commit made by git on the runner is unsigned, so the pull request this job opened would have satisfied the pull-request rule and then failed required_signatures forever. DriveBenderUtility hit exactly that and its coverage-matrix pull request had to be re-signed by hand before it could be merged.

publish-generated-file@v1 commits through the contents API, which GitHub signs, and keeps one long-lived bot/changelog branch rather than one per release marker — a changelog is worth one open pull request, not one per release.
One long-lived branch rather than one per release marker, and the commit is made through the contents API so it is signed.
A release-time changelog cannot be a pull-request check — nothing generates it until a release is cut — and a bot pull request carrying it would need a signed commit to be mergeable and a personal access token before its own checks would run, for a file the dated Release already states in full.

It is uploaded as the changelog artifact instead, and the committed copy is refreshed when that is worth doing. The release job stops needing pull-requests: write.

The release marker still tags the commit the packages were built and published from, which is the part of this branch that was right all along.
@Hawkynt
Hawkynt force-pushed the fix/release-changelog-via-pr branch from 8544a7e to f9e9d04 Compare August 29, 2026 12:52
@Hawkynt
Hawkynt merged commit 0f141bd into main Aug 29, 2026
8 checks passed
@Hawkynt
Hawkynt deleted the fix/release-changelog-via-pr branch August 29, 2026 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant