Skip to content

Gitリリースノート作成 V1

想定用途

  • Gitタグ間のコミット履歴からリリースノートを自動作成したい
  • コード差分を分析して詳細な変更内容を記載したい
  • GitHubでリリースノートを公開したい

プロンプト本文

# Gitリリースノート作成プロンプト V1

以下の手順に従って、GitHubリポジトリの指定したタグ間のコミット履歴とコードの差分からリリースノートを作成してください。

v0.1.0 のリリースノートを作成して
1つ前のタグと差分を比較して

## 必要なコマンド

```bash
# 指定タグ間のコミット取得
git log [前回のタグ]..[現在のタグ] --pretty=format:"%h %s"

# 指定タグ間のコード差分取得
git diff [前回のタグ] [現在のタグ] --name-status
git diff [前回のタグ] [現在のタグ]

# 統計情報の取得
コミット数: git log [前回のタグ]..[現在のタグ] --oneline | wc -l
貢献者数: git log [前回のタグ]..[現在のタグ] --format="%an" | sort -u | wc -l
変更ファイル数: git diff --name-only [前回のタグ]..[現在のタグ] | wc -l

処理手順

  1. コミットメッセージからIssue番号(#数字の形式)を抽出してください。

  2. コード差分を分析し、変更の内容をより詳細に把握してください。

    • 新しく追加された関数や機能
    • 修正されたバグの詳細
    • パフォーマンス改善の具体的な変更点
    • 設定変更やバージョンアップの詳細
  3. コミットをカテゴリに分類してください:

    • ✨ 新機能: feat、add、新機能、追加などのキーワードを含むコミット
    • 🐛 バグ修正: fix、修正、バグなどのキーワードを含むコミット
    • ⚡ パフォーマンス改善: perf、performance、最適化などのキーワードを含むコミット
    • 📚 ドキュメント: doc、ドキュメントなどのキーワードを含むコミット
    • 🔧 設定変更: config、設定、環境などのキーワードを含むコミット
    • 🔄 その他の変更: 上記のカテゴリに該当しないコミット
  4. 各変更に対して、コード差分から得られた具体的な情報を追加してください。

  5. gh コマンドを使用してリリースノートを作成して

  • gh コマンドは既に認証済みです

リリースノート形式

リリースノートは以下の構造で作成してください:

markdown
# 🚀 リリースノート: [現在のタグ]

## 🗓️ [現在の日付]

## ✨ 新機能
- 🆕 [コミットメッセージ] ([Issue番号])
  - [コード差分から得られた詳細情報]

## 🐛 バグ修正
- 🔧 [コミットメッセージ] ([Issue番号])
  - [バグの詳細と修正内容]

## ⚡ パフォーマンス改善
- ⚡ [コミットメッセージ] ([Issue番号])
  - [パフォーマンス改善の詳細]

## 📚 ドキュメント
- 📝 [コミットメッセージ] ([Issue番号])
  - [ドキュメント更新の詳細]

## 🔧 設定変更
- 🔧 [コミットメッセージ] ([Issue番号])
  - [設定変更の詳細]

## 🔄 その他の変更
- 🔄 [コミットメッセージ] ([Issue番号])
  - [変更の詳細]

## 📊 統計
- 📦 コミット数: [数値]
- 👥 貢献者数: [数値]
- 📄 変更ファイル数: [数値]
- 📈 追加行数: [数値]
- 📉 削除行数: [数値]

注意事項

  • 絵文字を効果的に使用して視認性を向上させてください
  • 各項目にはIssue番号を必ず含めてください
  • コード差分の情報を活用して、技術的な変更内容を詳細に説明してください
  • 重要な変更や破壊的変更には特に注意を払い、目立つように記載してください
  • 同じカテゴリ内の項目は重要度順に並べてください

## 使い方

1. Gitリポジトリで対象タグを作成済みであることを確認
2. プロンプトをAIチャットツールに入力
3. 対象のタグ名と前回のタグ名を指定
4. 生成されたリリースノートを確認して公開

## 入力例

v1.0.0 のリリースノートを作成して 1つ前のタグ(v0.9.0)と差分を比較して


## 出力例

- カテゴリ別に分類された変更点一覧
- Issue番号付きの詳細説明
- 統計情報(コミット数、貢献者数、変更ファイル数等)
- 絵文字付きの見やすいマークダウン形式