release: 0.7.1-rc.2 - #61
Merged
Merged
Conversation
The rules for this file lived in three places that had drifted apart: CONTRIBUTING carried a word cap, check-changes asked for a bullet per feat/fix/refactor/perf commit, and nothing anywhere said what does not belong. So refactors, CI work and bugs that never shipped all got entries, and the file drifted from a reason to upgrade toward a commit log with worse formatting. The rules now sit at the top of CHANGES.md, where someone about to add a bullet is already looking, and everything else defers to them rather than restating them. The one that changes most in practice: a fix earns an entry only when the bug was BROKEN IN A RELEASED VERSION. A defect introduced and fixed on the same branch never reached a user, so the changelog has nothing to say about it -- which is most fixes on a long branch, and the case check-changes was most likely to report as a gap. check-docs learns that `## Development` is no longer the first line: the block sits above it because release-notes.mjs extracts from a `## Version` heading to the next `## `, so anything above the first one cannot reach a GitHub release. Verified both ways.
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.
Cuts a second release candidate for 0.7.1, and moves the changelog's rules into the file they govern.
The rules block
CHANGES.mdnow opens with a comment stating what earns an entry and what does not. Everything else defers to it rather than restating it.The rules had been living in three places that drifted apart:
CONTRIBUTING.mdcarried a 25-word cap,check-changesasked for a bullet perfeat/fix/refactor/perfcommit, and nothing anywhere said what does not belong. The result was predictable -- refactors, CI work and bugs that never shipped all earned entries, and the file drifted from "a reason to upgrade" toward a commit log with worse formatting.The rule that changes most in practice: a fix earns an entry only when the bug was broken in a released version. A defect introduced and fixed on the same branch never reached anyone, so the changelog has nothing to say about it. On a long branch that is most fixes -- and it is exactly the case
check-changeswas most likely to report as a missing entry.What that does to this release
Applying the block to the entries already staged for 0.7.1 removed two of three:
That also retires the
### Internalsection this branch briefly introduced: the block leaves no room for it, and a file whose header forbids its own contents is worse than either rule alone.One bullet for the release. That is what this release actually contains that a user can see.
Aligned
CONTRIBUTING.md-- points at the block as authoritative; keeps the 25-word cap, which the block does not cover..agents/skills/check-changes/SKILL.md-- no longer demands an entry perrefactor; encodes the released-version rule; checks the block's soft (10) and hard (50) bullet limits..agents/skills/check-docs/SKILL.md--## Developmentis no longer the first heading.AGENTS.md-- entries are planned against the block, and most of a plan's tasks earn none.CLAUDE.md-- no changelog rules to align; left alone.Verified
The block sits above
## Developmentdeliberately:release-notes.mjsextracts from a## Versionheading to the next##, so nothing above the first one can reach a GitHub release. Confirmed it does not leak, on this version and on 0.7.0.bump-version.mjsstill finds^## Development$.The previous
v0.7.1-rc.1tag and its pre-release have been deleted;v0.7.0isLatestagain.