docs: version alignment is release-time, not feature-PR-time#65
Merged
Conversation
Adds a section to docs/changelog-guide.md telling the PR reviewer that in autoRelease repos a feature PR keeps `## Unreleased` and does NOT bump manifest version strings (plugin.json/marketplace.json/pyproject/ Cargo) -- the release agent aligns them post-merge. Prevents the recurring false-positive 'version alignment violation' the reviewer raised on every autoRelease feature PR. Adds a matching validation item.
There was a problem hiding this comment.
PR Review Complete
Review scope: 2 files changed (CHANGELOG.md +4 lines, docs/changelog-guide.md +17 lines)
Step 0c diff: No code changes — pure documentation additions.
Step 5: Consolidated Report
Must Fix (Critical): None.
Should Fix (Important): None.
Nice to Have (Optional): None.
Selector mode traceability:
- Rule candidates triggered:
changelog/preamble-frozen(CHANGELOG.md touched),changelog/conventional-prefix-required(CHANGELOG.md touched) - Both rules: judgment-tier; mechanically validated by review of the actual diff
changelog/preamble-frozen:## Unreleasedis correctly placed immediately after the SemVer preamble bullets, before## v0.28.0— ✅changelog/conventional-prefix-required: The new bullet usesdocs:prefix — ✅ valid per prefix table
Step 4 outcome: No violations found in the diff.
Step 6: Next Steps
No test coverage gaps or code changes — pure documentation PR. No /go-write-test suggestion needed.
Step 7: Manual Review
Reviewed both changed files:
- CHANGELOG.md:
docs:bullet is specific (names the doc and explains the purpose clearly), prefix is valid,## Unreleasedplacement is correct, no vague language. - docs/changelog-guide.md: New section "Version Alignment Is Release-Time, Not Feature-PR-Time" follows the existing doc style (header + explanation + review guidance + checklist item). The checklist item at line 179 matches the format of the other 7 items above it. The content correctly distinguishes
## Unreleased(not a version string) from versioned## vX.Y.Zentries.
Worktree cleanup: N/A — ran against current checkout.
{
"verdict": "approve",
"summary": "Pure documentation PR adding a clarification section to changelog-guide.md explaining that in autoRelease repos, feature PRs correctly keep manifest versions at the last released version while using ## Unreleased — the four-string alignment is a release-time gate, not a feature-PR gate. No violations found.",
"comments": [],
"concerns_addressed": [
"correctness: docs/changelog-guide.md new section follows existing doc style and checklist item format matches the Validation section — confirmed",
"correctness: CHANGELOG.md entry follows existing changelog format conventions (docs: prefix, specific description, correct ## Unreleased placement) — confirmed"
]
}
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
Adds a Version Alignment Is Release-Time, Not Feature-PR-Time section to
docs/changelog-guide.md.Why
The PR reviewer (which loads
changelog-guide.mdwhenever a diff touchesCHANGELOG.md) raised a CRITICAL "version alignment violation" on vault-cli#41 — a feature PR that correctly added a## Unreleasedbullet without bumpingplugin.json/marketplace.json. In anautoRelease: truerepo that's the correct state: manifests stay at the last released version and the release agent bumps everything post-merge. The guide already said "## Unreleasedon feature branches — never a version number" but never told the reviewer that the four version strings stay unbumped on feature PRs.Left unfixed, this false positive recurs on every autoRelease feature PR that adds an Unreleased bullet (the bborbe default).
Change
## Unreleased+ unbumped manifests; alignment is a release-time gate (make release-check), not a feature-PR gate. Explicit "do NOT flag as a violation" review guidance.## Validationchecklist item.Prompted by the false positive on bborbe/vault-cli#41.