過去バージョンのドキュメントはこちらです。
docs/archive/README.md
GitHub GraphQL API を直接叩いて マージ済み Pull Request を自動収集 & Markdown に整形 する CLI ツールです。
- 直近のマージ PR を取得
- Author ごとに番号をグルーピング
- テンプレートを使って Markdown に整形
- 環境チェック
- カレントディレクトリが
.git管理下か確認 - GitHub Token がセットされているか確認(Keychain / 環境変数)
mainブランチの最新マージ日時を取得
hotfix/xxx形式のブランチは除外して検索
- その日時〜現在までに
developにマージされた PR を収集 - PR を
author(ログイン名)ごとにグルーピング - Markdown へ整形し、以下の形式で出力
./releasePrMarkdown/release_YYYYMMDD_hhmm.md
GitHub GraphQL API へアクセスします。Releases ページ から対応する実行ファイルをダウンロードしてください。 基本的な利用方法は以下のとおりです。
GitHub Token をキーチェーン(OS の資格情報ストア)に保存して利用します。
# 対話プロンプトで Token を保存
./gh-pr-formatter auth login
# 保存済み Token を確認
./gh-pr-formatter auth status
# Token を削除
./gh-pr-formatter auth logoutCI など対話入力ができない環境では、環境変数 GH_PR_FORMATTER_TOKEN に Token を設定してください。
カレントディレクトリが Git 管理リポジトリである場合、
そのリポジトリを対象として処理を実行します。
./gh-pr-formatter--repo オプションを使用すると、対象とするリポジトリを明示的に指定できます。
./gh-pr-formatter --repo owner/repo
# e.g.
./gh-pr-formatter --repo 4okimi7uki/gh-pr-formatter
--repoを指定した場合、カレントディレクトリがGit管理下である必要はありません。
./releasePrMarkdown/release_YYYYMM_HHmm.md が生成されます。
中身をコピーしてPRに貼り付けてください!
2025 Aoki Mizuki – Developed with 🍭 and a sense of fun.