document-release

Updates project documentation files to match shipped code changes after a release.

Updated Apr 5, 2026
One-click install
npx skills add https://github.com/Simon-YHKim/eject-button --skill document-release-simon-yhkim
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Simon-YHKim/eject-button/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/Simon-YHKim/eject-button --skill document-release-simon-yhkim

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? After shipping code, project documentation like README, ARCHITECTURE, CONTRIBUTING, and CHANGELOG often drifts out of sync with what actually shipped. This Skill audits every documentation file against the git diff and brings them back into alignment before the PR merges. ## Core Features & Use Cases - Diff-Driven Doc Audit: Reads all project markdown files and cross-references them against the branch diff to find stale features, paths, counts, and version numbers. - Safe Auto-Updates with Guardrails: Applies factual corrections automatically while asking the user before risky narrative changes, VERSION bumps, or CHANGELOG rewrites. - CHANGELOG Voice Polish and PR Body Sync: Polishes changelog wording without clobbering entries, cleans up TODOS, and appends a Documentation section to the GitHub or GitLab PR body. - Use Case: After merging a feature branch that added a new command, run this Skill to update the README feature table, fix the project structure tree in CLAUDE.md, polish the CHANGELOG entry, and push a docs commit to the same PR. ## Quick Start Ask the assistant to run the document-release workflow to update all project docs for the changes on the current feature branch.

Frequently Asked Questions about document-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update project documentation after shipping code?

Run the document-release workflow from a feature branch after code is committed. It reads every markdown file in the repo, cross-references the branch diff, auto-applies factual fixes, and asks before any risky narrative or version changes.

What documentation files does a post-ship docs audit cover?

The audit covers README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, CHANGELOG.md, TODOS.md, and VERSION, plus any other markdown files found in the repo. Each file is checked against the diff for stale features, paths, counts, and cross-references.

Does document-release work with GitLab merge requests?

Yes, it detects the hosting platform from the git remote and uses glab for GitLab or gh for GitHub. It updates the PR or MR body with a Documentation section describing each doc change, and falls back to git-native commands if neither CLI is available.

Will it rewrite or bump my CHANGELOG and VERSION automatically?

No. CHANGELOG entries are only polished for wording, never deleted or regenerated, and edits use exact string matches. VERSION bumps always require explicit user confirmation through a prompt, even if a bump already exists on the branch.

When should I run document-release in the release workflow?

Run it after code is committed and a PR exists or is about to exist, but before the PR merges. It must run from a feature branch, not the base branch, so it can diff against the target branch.