fix(ci): sync README on release branch after release-plz release-pr#277
Closed
zeitlinger wants to merge 5 commits into
Closed
fix(ci): sync README on release branch after release-plz release-pr#277zeitlinger wants to merge 5 commits into
zeitlinger wants to merge 5 commits into
Conversation
After release-plz release-pr pushes the release branch with the bumped Cargo.toml + CHANGELOG, check it out and run release:docs-sync there, then push any README/Cargo.lock updates as an additional commit. Without this the README pin stays at the previous version and the readme_quickstart_tools_snippets_stay_current test fails on the release PR (as seen on #242 after the v0.22.0 bump). This was the second commit of #276 that didn't make it through the squash merge. Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the release PR automation so that after release-plz release-pr updates the release-plz-* branch, the workflow checks out that branch, runs a docs sync task, and pushes any resulting README/lockfile updates as an additional commit—keeping the release PR consistent with the bumped crate version.
Changes:
- Update
.miserelease PR task to runrelease-plz release-prand then locate the latestrelease-plz-*branch. - Check out the release branch, run
release:docs-sync, and push a follow-up commit when docs changed. - Push uses an explicit token-authenticated GitHub HTTPS URL to work with
actions/checkoutusingpersist-credentials: false.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Address Copilot feedback on #277: - Call `sync-readme-snippets` directly instead of `release:docs-sync`, which also runs `flint --fix` against all linters and could pick up unrelated drift onto the release branch. - Fail explicitly when `GITHUB_REPOSITORY` is unset instead of falling back to `grafana/flint`. The task is CI-only; outside CI the fallback could push to upstream unexpectedly. Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
martincostello
previously approved these changes
May 8, 2026
Per Martin's review feedback on #277: instead of hardcoding github-actions[bot] as the commit author, query the GitHub API for the token's actual user so the commit identity matches the GitHub identity that owns the push. Works for both the default GITHUB_TOKEN (github-actions[bot]) and a PAT (a real user). Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Member
Author
|
obsolete with #280 |
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.
Summary
After
release-plz release-prpushes the release branch with the bumpedCargo.toml+CHANGELOG, check it out and runrelease:docs-syncthere, then push anyREADME/Cargo.lockupdates as an additional commit.Why
Without this the README pin stays at the previous version and the
readme_quickstart_tools_snippets_stay_currenttest fails on the release PR — that's what blocked #242 after the v0.22.0 bump.This was the second commit of #276 that didn't make it through the squash merge.
Caveats
https://x-access-token:$TOKEN@github.com/...for the push becauseactions/checkoutruns withpersist-credentials: false.Test plan