Repository navigation
docs: state the release and tag rules - #85
Merged
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The documentation incorrectly treats Git-tag dependencies as immutable, overlooking that moved tags can cause fresh and lockfile-based installs to resolve different code.
1 open issue
What changed in this PR
This documentation-only PR establishes release and tag rules for maintainers and links them from the release guide.
Changes:
- Reserves final version tags for releases and uses release-candidate tags for test builds.
- Documents public-tag immutability and planned tag-ruleset enforcement.
- Requires bad releases to be documented and fixed in a new version rather than replaced.
| File | Description |
|---|---|
docs/release.md |
Adds a “Tags are final” summary linking to the full policy. |
CONTRIBUTING.md |
Adds release, versioning, tag-protection, and bad-release handling rules. |
Review effort: Balanced
The release workflow published a vX.Y.Z-rc.N tag as a regular release, and needed a CHANGELOG section for the RC version that the docs never mentioned. It now sets prerelease for any tag with a suffix, and the docs name the RC section. The tag rule also claimed every registry keeps the first copy of a tag for good. It does not: git dependencies resolve a moved tag afresh while lockfiles keep the old commit, and sum.golang.org records checksums, not code. The rule stays; the reason now says what actually goes wrong.
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
vX.Y.Ztag only for final code,vX.Y.Z-rc.Nfor test builds, a public tag never moved, deleted or reused (the Go module proxy,sum.golang.org, Packagist and npm keep the first copy they fetch), the tag ruleset that enforces it once the v0.1.0 tags are pushed, and a bad release retracted and fixed forward (named in the CHANGELOG and release notes; Packagist has no per-version retraction).Docs only; no code or metadata changes.