プルリクエストの使用方法
目次
プルリクエストとは
プルリクエストとは、ある開発ブランチの変更を他の開発者のブランチに取り込んでもらうためのリクエストを出す機能のことです。
Backlogのプルリクエストでは、次のようなことができます。
- 機能追加や改修などの内容を、レビュー・マージ担当者やその他関係者にお知らせする
- ソースの変更箇所をわかりやすく表示する
- コードについて意見や質問をコメントする
詳しくはプルリクエストとは？ - サル先生のGit入門を参照してください。
プルリクエストの一覧
プルリクエストの一覧画面では、登録済みのプルリクエストの一覧を表示できます。
プルリクエストの閲覧画面へは、以下の方法でアクセスしてください。
- プロジェクト左側メニューの「Git」をクリック
- 「リポジトリ一覧」より、該当のリポジトリの「プルリクエスト」をクリック
状態ごとに表示を切りかえる
最初に画面を開くと、状態が「Open」のプルリクエストだけが一覧に表示されています。
状態が「Close」や「Merged」のプルリクエストを表示したい場合は、テーブルヘッダーの「状態」をクリックしフィルターを変更してください。
プルリクエストを検索する
プルリクエストの一覧を絞り込んで表示したい場合は「🔍キーワード」にキーワードを入力してください。
プルリクエストの追加
プルリクエストの追加方法
プルリクエストの追加は、Gitのブランチ画面、ブランチ / タグ間差分の画面、もしくはプルリクエストの一覧画面で行うことができます。
【プルリクエスト画面への遷移方法】
- ブランチ画面の場合：「プルリクエスト」列にある「追加」をクリック
- ブランチ / タグ間差分画面の場合：「タグ」や「ブランチ」のタブにある「差分」をクリックして、ブランチ / タグ間差分画面に遷移 > 「プルリクエストの追加」をクリック
- プルリクエストの一覧画面の場合：「＋プルリクエストの追加」をクリック
次の手順でプルリクエストを追加してください。
- 「ブランチ」で、ターゲットブランチ（プルリクエストをマージする対象のブランチ）とプルリクエストブランチ（マージしてもらうブランチ）を選択します
- 件名を入力します
- 「担当者」には、プルリクエストのレビューやマージを担当するユーザーを選択します
- プルリクエストを追加したユーザーと担当者が異なる場合は自動で担当者にお知らせが届きます
プルリクエストの入力項目一覧
|
入力項目 |
詳細 |
|
ターゲットブランチ（必須） |
プルリクエストをマージする対象のブランチを指定します。 |
|
プルリクエストブランチ（必須） |
マージしてもらうブランチを指定します。 |
|
件名（必須） |
プルリクエストの件名を入力します。 |
|
プルリクエストの詳細 |
プルリクエストの依頼文、共有事項などを記載します。 |
|
担当者 |
ブランチのマージを担当するユーザーを指定します。 |
|
関連課題 |
プルリクエストに関連する課題を紐付けます。 |
|
プルリクエストの追加をお知らせしたいユーザー |
プルリクエストの担当者以外に、プルリクエストの追加をお知らせしたいユーザーがいる場合に入力します。 |
プルリクエスト追加のポイント
ターゲットブランチとプルリクエストブランチを選択したタイミングで、「コミット履歴」と「ファイル」の差分が閲覧できます。
また、プルリクエストブランチの名前に、Backlogの課題キーを含めておくと、その課題の件名がプルリクエストの「件名」に表示されます。「関連課題」にその課題キーが自動で設定され、変更も可能です。
プルリクエストのサンプル
プルリクエストの編集
プルリクエストの一覧画面で任意のプルリクエストを選択して詳細画面に進み、「編集」をクリックすると、プルリクエストを編集できます。
ターゲットブランチ（プルリクエストをマージする対象のブランチ）とプルリクエストブランチ（マージしてもらうブランチ）は変更できません。
プルリクエストのコメント
プルリクエストのコメントは課題のコメントのように、お知らせしたいユーザーを指定してコメントできます。
プルリクエストの登録時や更新時、コメント登録時に送信されるメールに対して返信してもプルリクエストのコメントは登録できません。
また、コードを指定してコメントができます。「ファイル」タブでコードを表示し、マウスオーバーした時に対象の行に表示されるコメントアイコンをクリックするとコメント欄が表示されます。
対応してほしい内容とお知らせしたいユーザーを入力し、登録をクリックします。
プルリクエストのクローズ
プルリクエストされたコードをマージせずにクローズする場合は、プルリクエストの詳細画面で「却下」をクリックします。
コメント欄が表示されるので、却下理由がある場合はコメント欄に記載して「却下」をクリックしてください。
プルリクエストのマージ
プルリクエストされたコードをマージする場合はプルリクエストの詳細画面で「マージ」をクリックします。
マージ後に作業ブランチを削除する
「マージ」をクリックする前に「マージされたあとにブランチ[ブランチ名]を削除する」にチェックを入れておけば、マージした後に作業ブランチが削除されます。
競合が発生している場合
コードが競合する場合は「競合が発生しているため、マージができません」というメッセージが表示され、Backlog上からはマージできません。この場合、競合を解消しマージしてください。
競合の解消方法は、競合の解決を参照してください。
もっとプルリクエストについて知りたい場合