docs(changelog): record the version-guard CHANGELOG-heading requirement - #118
Merged
Conversation
#117 added a hard gate — a version bump whose version has no matching "## [X.Y.Z]" heading in CHANGELOG.md now fails the PR — but shipped with no changelog entry of its own, so the guard that exists to stop undocumented releases was itself undocumented. Files it under [Unreleased] > Added, matching how the previous version-guard change (the src/**/*.ts bundle-only exemption) was recorded. Docs-only: .github/ does not ship and CHANGELOG.md is not shipped bytes, so no version bump is owed.
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
1 participant
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.
#117 added a hard gate to
version-guard: a version bump whose version has no matching## [X.Y.Z]heading in CHANGELOG.md now fails the PR, so release notes can't be stranded under## [Unreleased]and silently orphaned once the release ships.It shipped with no CHANGELOG entry of its own — the guard that exists to stop undocumented releases was itself undocumented. This files it under
[Unreleased]>Added, matching how the previousversion-guardchange (thesrc/**/*.tsbundle-only exemption) was recorded in this file.Docs-only.
.github/does not ship and CHANGELOG.md is not shipped bytes, so no version bump is owed andrequire-version-bumpshould pass unchanged.Found by the standing
/mcpscandocs+changelog audit; applied to all four servers in one pass.