ci: auto-bump README version pin via release-please#145
Merged
Conversation
Configures release-please to keep the README usage example pinned to the current exact version automatically, instead of bumping it by hand: - release-please-config.json: add extra-files generic updater for README.md - README.md: pin to @v6.0.0 (current latest) + x-release-please-version marker - release-please.yml: add issues: write (used by release-please for label management; prevents intermittent labeling failures) From now on the release PR rewrites the README pin (e.g. @v6.0.0 -> @v6.1.0) in-band, so consumers always copy a current exact pin and there's no manual version-bump feat commit. No floating major tag is introduced (exact pins match the repo's supply-chain posture).
Contributor
|
⬇️ Download the full plan (tofu-plan.txt): https://github.com/GlueOps/github-actions-opentofu-continuous-delivery/actions/runs/28248242654/artifacts/7909632078 OpenTofu PlanShow plan |
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.
What
Makes release-please keep the README usage example pinned to the current exact version automatically, instead of bumping it by hand.
release-please-config.json— add anextra-filesgeneric updater forREADME.md:README.md— pin to@v6.0.0(current latest) and add the marker:release-please.yml— addissues: write(release-please uses it for label management; prevents intermittent labeling failures).Effect
From the next release on, the release PR rewrites the README pin in-band (e.g.
@v6.0.0→@v6.1.0) alongside the changelog/manifest. No more manualfeat:version-bump commits, and consumers always copy a current exact pin.Deliberately no floating major tag — exact pins match this repo's supply-chain posture (the alternative considered, a moving
@v6, was rejected for that reason).Verify on first release
The generic updater matches the
6.0.0semver portion and preserves the@vprefix. Worth eyeballing the first release PR after this merges to confirm it produces@v6.1.0(correct) and not a droppedvor wrong component.Note
This is
ci:(release tooling), so it won't itself cut a release — it takes effect on the nextfeat:/fix:release PR.