Skip to content

4okimi7uki/gh-pr-formatter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gh-pr-formatter

Go Version CI

過去バージョンのドキュメントはこちらです。
docs/archive/README.md

GitHub GraphQL API を直接叩いて マージ済み Pull Request を自動収集 & Markdown に整形 する CLI ツールです。

  • 直近のマージ PR を取得
  • Author ごとに番号をグルーピング
  • テンプレートを使って Markdown に整形

動作フロー

  1. 環境チェック
  • カレントディレクトリが .git 管理下か確認
  • GitHub Token がセットされているか確認(Keychain / 環境変数)
  1. main ブランチの最新マージ日時を取得
  • hotfix/xxx 形式のブランチは除外して検索
  1. その日時〜現在までに develop にマージされた PR を収集
  2. PR を author(ログイン名)ごとにグルーピング
  3. 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 logout

CI など対話入力ができない環境では、環境変数 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 管理下である必要はありません。

Output

./releasePrMarkdown/release_YYYYMM_HHmm.md が生成されます。

中身をコピーしてPRに貼り付けてください!


2025 Aoki Mizuki – Developed with 🍭 and a sense of fun.

About

A CLI tool for collecting merged PRs and formatting them as Markdown — built with Go.

Resources

Stars

Watchers

Forks

Packages

No packages published