GitHub issue からブランチ作成する新機能 - issue と PR を自動リンク

issue の画面からブランチを作成する機能がリリースされました。

issue からブランチが作れると何が嬉しいのかパッとは分かりづらいですね。この機能により、従来 Pull Request (PR) 作成時 issue にメンション飛ばしたり issue から PR をリンクしたりしてたのが自動化されます。では使い方を見ていきましょう。

issue の右下に Create a branch リンクが出現しています。

このリンクをクリックするとブランチ作成画面がポップアップします。issue 番号とタイトルからブランチ名を自動生成してくれてます。必要に応じてブランチ名を修正して Create branch ボタンをクリックするとブランチが作成されます。

Caution

issue タイトルに日本語が入っているとブランチ名にも入ることになり Git クライアントで扱いづらくなります。issue タイトルを英語で登録するか、日本語タイトルの issue ではブランチ名を英語に修正するかプロジェクトで方針を決めるとよいでしょう。

あとはローカルで checkout して作業できます。

ブランチ作成後は Development セクションに作成したブランチが関連づけられています。

このブランチをチェックアウトし更新して PR を作ります。

PR の画面では何もしなくてもブランチを作成した issue にメンションが飛びます。

issue の Development セクションに自動リンクされた PR が表示されます。

issue の history にも PR がリンクされた履歴が追加されます。

issue に別のブランチを追加したい場合は Development セクションの⚙ボタンをクリックすると PR リンク UI の下にブランチ作成メニューが出ます。

既存のブランチと被らないように自動生成されたブランチ名には枝番がついています。

以上のように issue ドリブンで作業できて PR と issue の関連づけが徹底されるのは、規模の大きいプロジェクトでは有効でしょう。ブランチ名を考えなくてよいというのも嬉しいのではないでしょうか。

本記事の執筆時点ではベータ版なので機能についてフィードバックを送ることも可能です。