Skip to content

ci: auto-bump README version pin via release-please#145

Merged
venkatamutyala merged 1 commit into
mainfrom
release-please-autobump-readme
Jun 26, 2026
Merged

ci: auto-bump README version pin via release-please#145
venkatamutyala merged 1 commit into
mainfrom
release-please-autobump-readme

Conversation

@venkatamutyala

Copy link
Copy Markdown
Contributor

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 an extra-files generic updater for README.md:
    "extra-files": [
      { "type": "generic", "path": "README.md" }
    ]
  • README.md — pin to @v6.0.0 (current latest) and add the marker:
    uses: GlueOps/github-actions-opentofu-continuous-delivery@v6.0.0 # x-release-please-version
  • release-please.yml — add issues: 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 manual feat: 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.0 semver portion and preserves the @v prefix. Worth eyeballing the first release PR after this merges to confirm it produces @v6.1.0 (correct) and not a dropped v or wrong component.

Note

This is ci: (release tooling), so it won't itself cut a release — it takes effect on the next feat:/fix: release PR.

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).
@github-actions

Copy link
Copy Markdown
Contributor

⬇️ Download the full plan (tofu-plan.txt): https://github.com/GlueOps/github-actions-opentofu-continuous-delivery/actions/runs/28248242654/artifacts/7909632078

OpenTofu Plan

Show plan
OpenTofu used the selected providers to generate the following execution
plan. Resource actions are indicated with the following symbols:
  + create

OpenTofu will perform the following actions:

  # null_resource.integration_test will be created
  + resource "null_resource" "integration_test" {
      + id = (known after apply)
    }

Plan: 1 to add, 0 to change, 0 to destroy.

Changes to Outputs:
  + ok = "integration-test"

@venkatamutyala venkatamutyala merged commit cf37a87 into main Jun 26, 2026
4 checks passed
@venkatamutyala venkatamutyala deleted the release-please-autobump-readme branch June 26, 2026 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant