Repository navigation
chore: add root CLAUDE.md to tidy up release announcements - #188
Merged
Merged
Conversation
The release workflow auto-posts a machine-generated announcement (raw changelog-builder output) to the repo and org Discussions. It mis-categorizes PRs, includes chore(release) noise, and buries breaking changes. Add .github/release-announcer/CLAUDE.md: instructions for an agent run that reads the latest release, reads the auto-posted Discussion body, reconstructs what actually changed from the CHANGELOG/PRs/diff, and rewrites the Discussion(s) into a clear, user-facing announcement (breaking changes first, plain-language highlights, upgrade steps). Includes a rewritten-by marker so it never re-announces, and read-only/no-fabrication/no-attribution guardrails. Force-added: CLAUDE.md is excluded by a global gitignore, but this one is a shared, committed automation playbook.
Replace the .github/release-announcer playbook with a simple instruction in the repo's root CLAUDE.md: when working in the repo, check whether the latest release's auto-posted Announcements discussion still has the raw, machine-generated body and, if so, rewrite it in place into a clear user-facing announcement (breaking changes first, plain highlights, upgrade line), grounded in CHANGELOG.md and the PRs. A <!-- cleaned-up --> marker prevents redoing it. CLAUDE.md is excluded by a global gitignore, so it is force-added here as an intentionally committed, shared file.
rahlk
changed the title
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.
Adds a root
CLAUDE.mdso any agent working in this repo notices a freshly-posted release announcement and cleans it up. No GitHub Action — it's just repo guidance the agent picks up.Motivation and Context
Every
vX.Y.Ztag auto-posts a machine-generated announcement (rawrelease-changelog-builderoutput) to the Announcements discussion (repo + org mirror incodellm-devkit/.github). It lists PR titles by commit prefix — mis-categorizes changes, includeschore(release)noise, and buries breaking changes. See discussion #187 (v1.4.0).What this adds
A short instruction in
CLAUDE.md: when working in the repo, find the latest release's Announcements discussion; if its body is still the raw auto-generated text (no<!-- cleaned-up -->marker), rewrite it in place into a clear, user-facing announcement — breaking changes first with migration steps, plain-language highlights, upgrade line, links — grounded inCHANGELOG.mdand the PRs/diff (no fabrication). Update viaupdateDiscussion, mirror to the org, stamp the marker so it isn't redone. Read-only on code; edits Discussions only.Types of changes
Note
CLAUDE.mdis excluded by a global gitignore, so it wasgit add -f'd — intentionally committed as shared repo guidance.