Skip to content

feat: /document-release skill — post-ship doc updates (v0.4.3)#109

Merged
garrytan merged 9 commits intomainfrom
garrytan/document-skill
Mar 16, 2026
Merged

feat: /document-release skill — post-ship doc updates (v0.4.3)#109
garrytan merged 9 commits intomainfrom
garrytan/document-skill

Conversation

@garrytan
Copy link
Owner

Summary

  • New /document-release skill — runs after /ship but before PR merge. Reads every doc file in the project, cross-references the diff, and updates README, ARCHITECTURE, CONTRIBUTING, CHANGELOG, and TODOS to match what shipped. Risky changes surfaced as questions; factual updates applied automatically.
  • Smart VERSION handling — instead of silently skipping already-bumped versions, compares CHANGELOG entry scope against the full diff and asks if significant uncovered changes exist.
  • CHANGELOG clobber protection — never uses Write tool on CHANGELOG.md, only Edit with exact old_string matches. Addresses a real incident where an agent replaced existing CHANGELOG entries.
  • /review Step 5.6 — documentation staleness check. Cross-references code changes against doc files and flags stale docs as INFORMATIONAL with a pointer to /document-release.
  • Fixes gstack-upgrade/SKILL.md missing from skill-check.ts — existing inconsistency with gen-skill-docs.ts findTemplates().
  • E2E test validates /document-release updates docs without clobbering CHANGELOG.
  • README updated: skill count 9→10, /document-release in skills table, install/uninstall sections, dedicated section with example.

Pre-Landing Review

No issues found. Pure Markdown/docs/test changes — no application code.

TODOS

  • Added 2 new items under Document-Release section:
    • P1: Auto-invoke /document-release from /ship (Step 8.5)
    • P2: {{DOC_VOICE}} shared resolver for DRY voice rules

Test plan

  • All static tests pass (155 tests, 0 failures)
  • E2E test validates CHANGELOG clobber protection

🤖 Generated with Claude Code

garrytan and others added 9 commits March 16, 2026 12:14
- README: skill count 9→10, added /document-release to skills table,
  install/uninstall sections, and dedicated section with example
- CHANGELOG: added /document-release bullet to v0.4.2 entry

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
New skill runs after /ship but before PR merge. Reads every doc file,
cross-references the diff, auto-updates factual changes, asks about
risky edits. CHANGELOG clobber protection: never uses Write tool on
CHANGELOG.md, only Edit with exact old_string matches.

Smart VERSION logic: instead of silently skipping already-bumped
versions, compares CHANGELOG entry scope against full diff and asks
if significant uncovered changes exist.

Also fixes gstack-upgrade/SKILL.md missing from skill-check.ts
SKILL_FILES array (existing inconsistency with gen-skill-docs.ts).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Review skill now cross-references code changes against doc files.
If a doc describes a feature that changed but the doc wasn't updated,
flags it as INFORMATIONAL with a pointer to /document-release.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
E2E test creates a repo with existing CHANGELOG entries, runs
/document-release, and asserts original entries survive. Critical
guardrail against the incident where an agent replaced CHANGELOG
entries during conflict resolution.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@garrytan garrytan merged commit a68244a into main Mar 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant