with one click
update-release-docs
main との差分と要件ドキュメントを参考に、次バージョン用の README と CHANGELOG を更新する
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Menu
main との差分と要件ドキュメントを参考に、次バージョン用の README と CHANGELOG を更新する
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | update-release-docs |
| description | main との差分と要件ドキュメントを参考に、次バージョン用の README と CHANGELOG を更新する |
| allowed-tools | Read, Edit, Bash(cd:*), Bash(git log:*), Bash(git diff:*), Bash(git status:*), Bash(git add:*), Bash(git commit:*) |
| argument-hint | <要件ドキュメントのパス> [バージョン] |
main ブランチとの差分と指定された要件ドキュメントを参照し、
次バージョン用の CHANGELOG.md と README.md を更新します。
~/work/ai/git-keizucd ~/work/ai/git-keizu を実行することスペース区切りで最大2トークンを受け取る。
| 位置 | 必須 | 説明 |
|---|---|---|
| 第1引数 | 必須 | 要件ドキュメントのパス(リポジトリルートからの相対パスまたは絶対パス) |
| 第2引数 | 省略可 | バージョン番号(例: 0.2.7 または v0.2.7、v-prefix は任意) |
# バージョンを明示する場合
/update-release-docs notes/features/007-foo/要件整理.md 0.2.7
# バージョンを省略する場合(package.json から自動取得)
/update-release-docs notes/features/007-foo/要件整理.md
引数が指定されていない場合は、要件ドキュメントのパスをユーザーに確認してから進めること。
コミットメッセージを生成する前に、以下を必ず実行すること。
docs/development/project-settings.md を Read ツールで読む
commit-language: en があれば英語、commit-language: ja または記述なしなら日本語を使用CLAUDE.md を Read ツールで読む
commit-language: を探す言語の優先順位: docs/development/project-settings.md > CLAUDE.md > グローバルデフォルト(日本語)
cd ~/work/ai/git-keizu
以下を並列で Read/Bash 実行し、内容を把握する:
$ARGUMENTS で指定されたファイルを Read ツールで読むgit log main..HEAD --oneline
git diff main...HEAD
差分が大きい場合は git diff main...HEAD --stat で概要を先に把握し、
必要なファイルだけ個別に Read で確認するCHANGELOG.md を Read ツールで読むREADME.md を Read ツールで読む# Read ツールで package.json を読み "version" フィールドを取得
v prefix は除去して正規化。例: v0.2.7 → 0.2.7)package.json の "version" フィールドを Read ツールで読んで使用する決定したバージョンが CHANGELOG に既存エントリとして存在する場合は処理を中断し、以下の形式でユーザーに確認する:
⚠️ CHANGELOG に [X.Y.Z] エントリが既に存在します。
- 別のバージョン番号を指定して再実行するか
- 既存エントリを上書きしても良い場合は「続行」と入力してください
ユーザーが「続行」または続行の意思を示した場合のみ、既存エントリを上書きして処理を進める。
## [Unreleased] セクションの直後に新バージョンのセクションを挿入する。
docs/development/project-settings.md の commit-language: en に準拠)Added / Changed / Fixed / Removed のうち該当するもの- **機能名**: 説明文 の形式。何を・どう変えたかを1文で明確に書くファイル末尾のリンク定義を更新する:
[Unreleased]: https://github.com/numlia/git-keizu/compare/v{新バージョン}...HEAD
[{新バージョン}]: https://github.com/numlia/git-keizu/compare/v{前バージョン}...v{新バージョン}
前バージョンは既存の CHANGELOG エントリから読み取ること。
## Features セクションのリストを更新する。
- **機能名**: 説明文 の箇条書き## Security セクション(機能変更でない限り手をつけない)## Installation / ## Contributing & Support / ## License セクションCHANGELOG.md と README.md をまとめて1コミットとして記録する。
docs: {説明} の prefix を使うdocs: update CHANGELOG and README for v{version}docs: v{バージョン}の CHANGELOG と README を更新(#issue-number) を含めない# Step 6-1: ステータス確認
git status
# Step 6-2: 対象ファイルをステージング(別々の Bash tool call で実行)
git add CHANGELOG.md README.md
# Step 6-3: コミット(HEREDOC 形式)
git commit -m "$(cat <<'EOF'
docs: {決定したメッセージ}
EOF
)"
更新後、以下の形式でレポートを出力する:
## 📊 Report
**Overview**: [バージョン X.Y.Z の CHANGELOG と README を更新・コミットした旨]
**Changed files**: 2 files
- `CHANGELOG.md`
- `README.md`
**CHANGELOG の主な変更**:
- Added: N 項目
- Changed: N 項目
**README の主な変更**:
- [追加・変更した bullet の概要]
**Next step**: /release X.Y.Z を実行してください
/commit は不要## [Unreleased] は空のまま: 新バージョンのセクションはその下に追加する