diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-08-25 22:19:02 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-08-25 22:19:02 +0300 |
| commit | 13df1da9837d895b8e0d6bd50ea9fa37e76f525c (patch) | |
| tree | 199addda2a1a0dafe3ecb734a766c7cb5860700f /.agents | |
| parent | 9ff467bda4aa0fcb79ccb4a04392b63e37ce7f37 (diff) | |
docs: move changelog curation to release prep
Diffstat (limited to '.agents')
| -rw-r--r-- | .agents/skills/herdr-pre-release-audit/references/pre-release-audit.md | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/.agents/skills/herdr-pre-release-audit/references/pre-release-audit.md b/.agents/skills/herdr-pre-release-audit/references/pre-release-audit.md index 2dfcb4d4..0544b18e 100644 --- a/.agents/skills/herdr-pre-release-audit/references/pre-release-audit.md +++ b/.agents/skills/herdr-pre-release-audit/references/pre-release-audit.md @@ -44,11 +44,14 @@ Process: - formatting-only changes - comment-only/doc-only changes unless they materially affect users -6. Audit `docs/next/CHANGELOG.md` and issue references. - - Treat root `CHANGELOG.md` as the latest released changelog. - - Treat `docs/next/CHANGELOG.md` as the next-release changelog. - - Compare meaningful user-facing changes in the commit range against `docs/next/CHANGELOG.md`. +6. Build the stable-release changelog inventory, then audit `docs/next/CHANGELOG.md` and issue references. + - Normal feature and fix work does not maintain `docs/next/CHANGELOG.md`. Stable release preparation owns the complete changelog update so long-lived pull requests do not conflict over one shared file. + - Treat root `CHANGELOG.md` as the latest released changelog and `docs/next/CHANGELOG.md` as the human-curated next-release changelog. + - Before judging the draft, inventory every merged PR and direct commit in the release range. Use conventional commit subjects, commit bodies, changed files, linked issues, PR bodies, and contributor identity as source material. Generated or grouped commit lists are a coverage aid, not final release prose. + - Classify each release unit as user-facing and changelog-worthy, internal/maintenance, docs-only, or needing a decision. Do not silently omit uncertain items. + - Compare every meaningful user-facing item in that inventory against `docs/next/CHANGELOG.md`. - Flag missing entries for new features, bug fixes, removals, breaking changes, defaults, compatibility changes, user-visible command/config/API behavior, and security-relevant changes. + - Final entries must be human-written at product height. Describe what users gain or no longer experience rather than copying commit subjects or implementation details. - Do not require changelog entries solely for internal client/server protocol version bumps. Mention protocol only when the release intentionally changes user-facing compatibility guidance beyond the normal restart requirement. - Inspect commit bodies for issue reference lines in the form `refs #<issue-number>`. - Flag normal commits that use GitHub closing keywords like `fixes #<issue-number>`, `closes #<issue-number>`, or `resolves #<issue-number>`, because they close issues before release when they land on `master`. @@ -84,7 +87,7 @@ Process: 9. Apply changes only when asked. - Do not edit files during the audit unless the user explicitly asks you to apply fixes. - - When asked to apply audit fixes, update `docs/next/CHANGELOG.md`, `docs/next/README.md`, and any required staged website docs under `docs/next/website/src/content/docs/`. + - Release preparation is the normal workflow that writes `docs/next/CHANGELOG.md`. When asked to apply audit fixes, human-write the approved changelog entries from the complete release inventory, and update `docs/next/README.md` plus any required staged website docs under `docs/next/website/src/content/docs/`. - When asked to finalize release docs, finalize only the staged files under `docs/next/`, then run `just release-docs-check`. Preview and stable publication remain CI-owned. Output format: |
