fix(mage): point every client's prompt at the real changelog - #115
Merged
Merged
Conversation
All seven generation prompts ended with "Update DESIGN.md changelog if needed". The changelog is CHANGELOG.md, and DESIGN.md does not contain one -- so for as long as regeneration has existed, it has been told to update a file that is not the changelog. #102 fixed the C# copy; this fixes the rest and stops there being copies at all. Seven byte-for-byte duplicates of one instruction is the duplication internal/clauderun was extracted to prevent, so the text lives there now as ChangelogInstruction and all seven reference it, C# included. It also gained a clause the old wording lacked: do not add a second "### Added"/"### Changed"/"### Fixed" beside one already under "## Unreleased", put the entry in the subsection that exists. That is not hypothetical tidiness -- writing entries by hand for this repository, I made exactly that mistake twice, in spicedb-ruby and spicedb-rust, and markdownlint's MD024 caught it both times. Telling the generator up front is cheaper than a red build and a follow-up commit. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
All seven generation prompts ended with:
The changelog is
CHANGELOG.md, andDESIGN.mddoes not contain one. For as long as regeneration has existed it has been told to update a file that is not the changelog. #102 fixed the C# copy; this fixes the remaining six — and removes the copies.One place, not seven
Seven byte-for-byte duplicates of a single instruction is precisely the duplication
internal/clauderunwas extracted to prevent — its own package comment says a third cross-cutting concern should trigger extraction. The text now lives there asChangelogInstruction, and all seven clients reference it, C# included (its local const from #102 is removed).A clause the old wording lacked
Not hypothetical tidiness. Writing changelog entries by hand for this repository I made exactly that mistake twice — in
spicedb-rubyandspicedb-rust— and markdownlint'sMD024caught it both times, each costing a red build and a follow-up commit. Telling the generator up front is cheaper than letting it rediscover this the same way I did.Verification
All seven Magefiles compile (
mage -l),gofmtclean,go test -tags mage ./...passes. Two tests pin the instruction: that it names the right file and the right headings, and that it never again says "DESIGN.md changelog".🤖 Generated with Claude Code