ci(release): tag releases plainly (vX.Y.Z), dropping the component prefix#240
Merged
Conversation
📝 WalkthroughWalkthroughUpdated manifest analyzer documentation with tagged-release pinning guidance and adjusted release automation to use module-wide tags with a new release baseline. ChangesRelease versioning alignment
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
sunib
force-pushed
the
fix/plain-semver-tags
branch
from
July 15, 2026 16:00
d495fa9 to
ce403f5
Compare
…efix The module is at the repository root, but release-please tagged releases `gitops-reverser-vX.Y.Z` (its package-name prefix). Go resolves a root module only by plain `vX.Y.Z` tags, so `go get .../@vX.Y.Z` and `go install .../cmd/manifest-analyzer@vX.Y.Z` failed and consumers of pkg/manifestanalyzer could pin nothing but a pseudo-version. Nothing depends on the prefix (every release-workflow reference uses release-please's tag_name output; image tags come from the version output), and the whole repo is a single Go module — so the prefix bought nothing. Set include-component-in-tag: false so release-please tags `vX.Y.Z` directly (one tag, Go-resolvable, no mirror job), and bump last-release-sha to the 0.36.0 release commit so the next changelog anchors correctly without matching the old prefixed tags. Existing `gitops-reverser-vX.Y.Z` tags stay as history; the next release cuts the first `vX.Y.Z`. Update pkg/manifestanalyzer's doc accordingly. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
sunib
force-pushed
the
fix/plain-semver-tags
branch
from
July 15, 2026 16:31
ce403f5 to
b31aa66
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@pkg/manifestanalyzer/doc.go`:
- Around line 19-23: Update the release-installation guidance in the package
documentation to apply the vX.Y.Z command only to releases after the migration,
and document the legacy gitops-reverser-vX.Y.Z form required by historical
releases. Preserve the existing explanation that the repository is versioned as
one Go module.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 6ed73f61-f5b2-433d-9c68-8db48f0c906b
📒 Files selected for processing (2)
pkg/manifestanalyzer/doc.gorelease-please-config.json
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.
The problem (finding #13)
pkg/manifestanalyzer's doc says "Pin a version." No consumer could: the module is at the repository root (module github.com/ConfigButler/gitops-reverser), but release-please tagged releasesgitops-reverser-vX.Y.Z. Go resolves a root module by plainvX.Y.Ztags only, so both consumers of this repo failed to resolve by version:Why drop the prefix instead of adding a second tag
An earlier version of this PR mirrored each release to a plain tag. On review, the prefix turned out to buy nothing:
gitops-reverser-v*. Every release-workflow reference uses release-please'stag_nameoutput; image tags come from theversionoutput. So emittingv0.36.0instead just works everywhere.manifest-analyzerCLI, and thepkg/manifestanalyzerlibrary are three artifacts, but onego.mod— one version. Thegitops-reverser-prefix is release-please's component format (hyphen), not Go's submodule convention (subdir/vX.Y.Z, slash), so it maps to no module boundary and can never make the artifacts independently versionable.go get) and CLI (go install) are exactly the consumers that need plainvX.Y.Zon the root module to resolve. A single tag versions all three artifacts together — which is the point (theinternal/clusterguard exists to keep the image and the linked library at the same release).The prefix would only earn its keep if a package were split into its own
go.mod— a real refactor (a separate module can't importinternal/), and even then its tag would bepkg/manifestanalyzer/vX.Y.Z(slash), not today's format.The change
release-please-config.json:"include-component-in-tag": false→ releases tagvX.Y.Zdirectly.last-release-shabumped to the0.36.0release commit so the next changelog anchors correctly without matching the old prefixed tags.pkg/manifestanalyzer/doc.go: the "Pin a version" note now says@vX.Y.Z(andgo install …@vX.Y.Z) resolve.Notes
gitops-reverser-vX.Y.Ztags stay as history; the next release cuts the firstvX.Y.Z. To make@v0.36.0resolve immediately, a maintainer can backfill once:git tag v0.36.0 gitops-reverser-v0.36.0 && git push origin v0.36.0.0.36.0) +last-release-sha, and it's validated on the next release to main.🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
go getandgo install.Chores