GitHub Pull Request のブランチを可視化する地味便利コマンドを公開しました

はじめに

こんにちは、やぐちはるおです。
年末に会社の人と雑談してたら地味便利プログラムが出来たので、誰でも使えるように npm パッケージとして公開しました。

https://www.npmjs.com/package/pull-request-graph

任意のリポジトリで以下のコマンドを打てば実行できます。

npx pull-request-graph

※ gh コマンドがインストールされている前提です。

どんな人や組織、タイミングで使うツールなのか

1. 大規模プロジェクトでブランチが乱立しているとき
2. 複数人がリリース前の最終調整でバグ修正や追加実装を行っているとき
3. 派生ブランチ同士に依存関係がある場合
4. プロジェクトの進捗報告やチームの共有ミーティングの振り返りをするとき
5. 複数のリポジトリで似たような構成の PR を管理しているとき

何が出来るのか

• ブランチの可視化
• クリックで PR ページに遷移
• ブランチが変な生え方してないか確認

実行するとこんな感じになります。

main からたくさん生えていたり、さらにそこから生えている PR が可視化されました。それぞれの PR がオープンされているかドラフトなのかも見えます。

開発の関係上、まだマージされていないブランチから派生したブランチで開発することがあると、変なブランチが生まれていないか確認することができます。

使い方

前提

• gh コマンドがインストールされている

インストールする場合

npm i -g pull-request-graph

実行方法

可視化したいリポジトリのディレクトリに移動して以下を実行

# インストールした人
pull-request-graph

# インストールしてない人
npx pull-request-graph

自動でブラウザが開きます。

謝辞

年末このツール思いつくきっかけとなった雑談をした I さん、クリックで PR ページに飛べるようにしてくれた tapioca さん、ありがとうございました。

さいごに

年末思いつきで作ったツールなので、まだ細かいエラーがちらほら出るかもしれませんが、もしバグっぽい挙動を見つけたらコメントや issue などくれると嬉しいです。

https://github.com/haruo2177/PullRequestGraph