// リリースノートを作成または更新するときに使う。直近タグ以降の変更、コミットログ、PR、Issue、コントリビューターを確認し、既存の形式に合わせて日本語のリリースノートを作成する。
| name | write-release-note |
| description | リリースノートを作成または更新するときに使う。直近タグ以降の変更、コミットログ、PR、Issue、コントリビューターを確認し、既存の形式に合わせて日本語のリリースノートを作成する。 |
このドキュメントは、直近のタグ以降のコンテンツ更新をまとめたリリースノートを作成するAIエージェント向けの指示書です。
読者に向けて、前回のリリース以降にどんなコンテンツの追加・更新があったかを分かりやすく伝えるリリースノートを作成します。技術書の更新情報として、読者が「今回はこんな内容が充実した」「このトピックを読んでみよう」と思えるような記事を目指します。
直近の YYYY-MM-DD 形式のタグを基準として、それ以降のコミットを対象とします。
# 直近のYYYY-MM-DD形式のタグを取得
git tag --list --sort=-creatordate | grep -E '^[0-9]{4}-[0-9]{2}-[0-9]{2}$' | head -1
# 今日の日付を確認
date "+%Y-%m-%d"
リリースノートのファイル名は docs/releasenotes/YYYY-MM-DD.md の形式です（例: 2026-01-10.md）。
今日の日付をファイル名として使用してください。
直近のタグ以降のコミットを確認します：
# 直近のYYYY-MM-DD形式タグを変数に格納
LAST_TAG=$(git tag --list --sort=-creatordate | grep -E '^[0-9]{4}-[0-9]{2}-[0-9]{2}$' | head -1)
echo "対象期間: $LAST_TAG 以降"
# タグ以降のコミットログを取得（詳細版）
git log ${LAST_TAG}..HEAD --no-merges --pretty=format:"%h %s"
# PRマージのみを確認したい場合
git log ${LAST_TAG}..HEAD --merges --pretty=format:"%h %s"
重要なコミットについては、具体的な変更内容を確認します：
# 特定のコミットの差分を確認
git show <commit-hash> --stat
git diff <commit-hash>^..<commit-hash> -- docs/
特に docs/ フォルダ配下の変更に注目してください。
コミットメッセージに (#数字) がある場合、関連するIssue/PRを確認します：
# GitHub CLIでIssue/PRの詳細を確認
gh issue view <issue-number>
gh pr view <pr-number>
PRの作者情報を確認して、コントリビューター一覧を作成します：
# PRの作者を確認
gh pr view <pr-number> --json author --jq '.author.login'
docs/releasenotes/YYYY-MM-DD.md
例: docs/releasenotes/2026-01-10.md
タイトルは以下の形式で、読者の興味を引く主要トピックを含めてください：
YYYY-MM-DD [主要トピック]YYYY-MM-DD [主要トピック]など例：
2026-01-10 Prettierチュートリアルを改善2026-01-10 プロジェクト参照チュートリアルをnpmに移行など---
date: YYYY-MM-DD
---
# YYYY-MM-DD [主要トピック]
YYYY年M月D日の更新内容をお届けします。
## ✨ ハイライト
<!-- 新規ページの追加、既存ページの大幅な加筆など、大きな更新を紹介 -->
### [更新タイトル]
[読者目線で、この更新がなぜ嬉しいか、何が学べるかを300字程度で説明]（[#PR番号] by [@username]）
[ページタイトル](リンク)
### 修正・改善
<!-- 誤字脱字、コードの修正、説明の明確化など -->
- [ページタイトル](リンク) - 修正内容（[#PR番号] by [@username]）
## 👥 コントリビューター
今回のアップデートに貢献してくださった方々です。ありがとうございます！
- [@username1]
- [@username2]
---
いつもサバイバルTypeScriptをご利用いただきありがとうございます。
ご意見・ご要望は [GitHub Issues](https://github.com/yytypescript/book/issues) までお寄せください。
<!-- PR参照リンク -->
[#1234]: https://github.com/yytypescript/book/pull/1234
[#1235]: https://github.com/yytypescript/book/pull/1235
<!-- コントリビューター参照リンク -->
[@username1]: https://github.com/username1
[@username2]: https://github.com/username2
PRはMarkdownの参照リンク形式で管理します：
[#PR番号] の形式で記載（例: [#1234]）[#PR番号]: https://github.com/yytypescript/book/pull/PR番号 を追加例：
- [Prettierチュートリアル](/tutorials/prettier) - EditorConfigの説明を追加（[#1063]）
<!-- PR参照リンク -->
[#1063]: https://github.com/yytypescript/book/pull/1063
コントリビューターはMarkdownの参照リンク形式で管理します：
[@username] の形式で記載[@username]: https://github.com/username を追加例：
## 👥 コントリビューター
- [@suin]
- [@example-user]
<!-- コントリビューター参照リンク -->
[@suin]: https://github.com/suin
[@example-user]: https://github.com/example-user
単なる変更リストではなく、その変更が読者にとってどんなメリットがあるかを説明してください：
| 変更の種類 | カテゴリ |
|---|---|
| 新しいページの追加 | 新規コンテンツ |
| 既存ページへの大幅な加筆 | 内容の充実 |
| 説明の明確化、例の追加 | 内容の充実 |
| 誤字脱字、コードの修正 | 修正・改善 |
以下の読者に直接関係ない変更は、リリースノートに含めないでください：
docs/releasenotes/YYYY-MM-DD.md に保存初回実行時は docs/releasenotes/ ディレクトリを作成してください。
YYYY-MM-DD 形式のタグが見つからない場合は、過去1週間のコミットを対象としてください：
git log --since="1 week ago" --no-merges --pretty=format:"%h %s"
更新が少ない場合は無理にリリースノートを作成する必要はありません。「大きな更新はありませんでした」と記載するか、次回にまとめても構いません。