次の方法で共有


pull request の作成

Azure DevOps Services |Azure DevOps Server |Azure DevOps Server 2022 |Azure DevOps Server 2020

Visual Studio 2019 |Visual Studio 2022

Git リポジトリでコードを変更、確認、およびマージするためのプル要求 (PR) を作成します。 PR は、アップストリーム リポジトリ内のブランチから、またはリポジトリの フォーク 内のブランチから作成できます。 チームは PR を確認 し、変更に関するフィードバックを提供できます。 校閲者は、提案された変更をステップ実行し、コメントを残し、PR の承認または拒否に投票できます。 ブランチ ポリシーやその他の要件によっては、PR を完了して変更をターゲット ブランチにマージする前に、PR がさまざまな条件を満たす必要がある場合があります。

PR のガイドラインと管理に関する考慮事項については、「 プル要求について」を参照してください。

[前提条件]

カテゴリ Requirements
アクセス レベル - PR を表示または確認する: 少なくとも 基本アクセス。 パブリック プロジェクトの場合、ユーザー の利害関係者アクセス は Azure Repos へのフル アクセス権を持ちます。
アクセス許可 - PR に貢献する: 閲覧者 セキュリティ グループまたは対応するアクセス許可のメンバー。
- PR: 共同作成者 セキュリティ グループのメンバー、または対応するアクセス許可を作成して完了します。
サービス リポジトリが有効になっています
ツール Azure DevOps CLI
カテゴリ Requirements
アクセス レベル - PR を表示または確認する: 少なくとも 基本アクセス
アクセス許可 - PR に貢献する: 閲覧者 セキュリティ グループまたは対応するアクセス許可のメンバー。
- PR: 共同作成者 セキュリティ グループのメンバー、または対応するアクセス許可を作成して完了します。
サービス リポジトリが有効になっています

アクセス許可とアクセスの詳細については、「既定の Git リポジトリとブランチのアクセス許可」および「アクセス レベルについて」を参照してください。

pull request を作成する

新しい PR は、Azure DevOps プロジェクト Web サイト、Visual Studio、または Azure DevOps CLI から作成できます。

Azure DevOps プロジェクト Web サイトから、次の場所から新しい PR を作成できます。

[Pull requests]\(プル要求\) ページから PR を作成する

Web 上のプロジェクトの Pull requests ページから任意のブランチの PR を作成できます。

  1. [ Repos>Pull requests ] ページで、右上にある [新しい pull request ] を選択します。

    [新しいプル要求] ボタンのスクリーンショット。

  2. 変更を含むブランチと、変更をマージするブランチ (メイン ブランチなど) を選択します。

    Azure Repos の P R のソース ブランチとターゲット ブランチのスクリーンショット。

  3. PR の詳細を入力 し、PR を作成します。

プッシュされたブランチから PR を作成する

機能ブランチをプッシュまたは更新すると、Azure Repos に PR を作成するためのプロンプトが表示されます。

  • [ Pull requests]\(プル要求\) ページで、次の手順を実行します

    Azure Repos の [Pull Requests] タブに P R を作成するプロンプトを示すスクリーンショット。

  • [ファイル] ページで、次 の手順を 実行します。

    Azure Repos の [ファイル] タブに P R を作成するプロンプトを示すスクリーンショット。

[ プル要求の作成 ] を選択して、 PR の詳細を入力して PR を作成できるページに移動します。

リンクされた作業項目から PR を作成する

ブランチにリンクされている Azure Boards 作業項目から直接 PR を作成できます。

  1. Azure Boards の [作業] ビューの [バックログ] または [クエリ] から、ブランチにリンクされている作業項目を開きます。

  2. 作業項目の [開発 ] 領域で、[ プル要求の作成] を選択します。

    リンクされたブランチを持つ作業項目の開発領域から PR を作成するスクリーンショット。

このリンクをクリックすると、 PR の詳細を入力して PR を作成できるページが表示されます。

cherry-pick を使用して更新プログラムを追加する

cherry-pick を使用して、あるブランチから別のブランチにコミットをコピーできます。 マージやリベースとは異なり、cherry-pick はブランチ内のすべての変更ではなく、選択したコミットからの変更のみを取り込みます。

完了した PR から変更を選択するには、PR の [概要] ページで [Cherry-pick] を選択します。 アクティブな PR から変更をコピーするには、PR の [その他のオプション] メニューから [Cherry-pick] を選択します。 このアクションにより、コピーされた変更を含む新しいブランチが作成されます。 その後、新しいブランチから新しい PR を作成できます。 詳細な手順については、「 チェリーピックを使用して変更をコピーする」を参照してください。

プル要求のソースブランチとターゲットブランチを切り替える

PR を初めて保存する前に、ブランチ名の横にある [ソースブランチとターゲットブランチの切り替え] アイコンを選択して、PR の ソースブランチとターゲットブランチを切り替 えることができます。 PR がアクティブになると、このアイコンは消えますが、PR のターゲット ブランチを変更 することはできます。

ソースとターゲットの分岐の切り替えアイコンのスクリーンショット。

pull request テンプレートを使用する

プル要求テンプレートは、PR の作成時に PR の説明を設定する Markdown テキストを含むファイルです。 PR の適切な説明は、PR レビュー担当者に期待される内容を伝え、単体テストの追加やドキュメントの更新などのタスクを追跡するのに役立ちます。 チームは、リポジトリ内のすべての新しい PR 説明にテキストを追加する既定の PR テンプレートを作成できます。 また、ブランチ固有のテンプレートや、チームが定義する他のテンプレートから選択することもできます。 PR テンプレートの作成と使用の詳細については、テンプレートを使用した pull request の説明の改善に関するページを参照してください。

リポジトリに既定のテンプレートがある場合、リポジトリ内のすべての PR には、作成時に既定のテンプレートの説明テキストが含まれます。 他のテンプレートを追加するには、[ テンプレートの追加 ] を選択し、ドロップダウン リストからテンプレートを選択します。 説明のテンプレート テキストを編集したり、削除したり、他のテキストを追加したりできます。

P R の作成時にテンプレートを追加するを示すスクリーンショット。

下書き PR を作成する

PR がレビューの準備ができていない場合は、進行中の作業を示す下書き PR を作成できます。 PR がレビューの準備ができたら、それを発行し、完全なレビュー プロセスを開始または再開できます。

ドラフト PR には、公開されている PR とは次の違いがあります。

  • ビルド検証ポリシーは自動的には実行されません。 PR のその他のオプション メニューを選択して、ビルド検証を手動でキューに登録できます。

  • 下書きモードの間、投票は無効になります。

  • 必須の校閲者は自動的に追加されません。 通知は、ドラフト PR に明示的に追加したレビュー担当者にのみ送信されます。

  • 下書き PR は、 下書 きバッジと共に PR リストに表示されます。

    [P R] リストの下書き P R を示すスクリーンショット。

下書き PR を作成するには、[ 作成 ] の横にある矢印を選択し、PR の作成時に [下書きとして作成 ] を選択します。 WIPDO NOT MERGEなどのタイトル プレフィックスを使用する必要はありません。

下書き PR として作成するを示すスクリーンショット。

PR を確認して完了する準備ができたら、PR の右上にある [発行 ] を選択します。 PR を発行すると、必要なレビュー担当者が割り当てられ、ポリシーが評価され、投票が開始されます。

PR の発行を示すスクリーンショット。

既存の発行済み PR を下書きに変更するには、[ 下書きとしてマーク] を選択します。 PR をドラフトとしてマークすると、既存のすべての投票が削除されます。

下書きとしてマークを示すスクリーンショット。

pull request のタイトルと説明を追加または編集する

[ 新しいプル要求 ] ページで、 タイトル と変更内容の詳細な 説明 を入力して、他のユーザーが変更によって解決される問題を確認できるようにします。 既存の PR と同様に新しい PR では、PR の [ファイルコミット ] を別のタブに表示できます。 校閲者の追加、作業項目のリンク、PR へのタグの追加を行うことができます。

変更を確認する準備ができたら、[ 作成 ] を選択して PR を作成します。

新しい P R の作成を示すスクリーンショット。

新しい P R に詳細を追加する。

PR を作成するときに、すべての作業項目、レビュー担当者、または詳細を準備していない場合は、心配しないでください。 PR を作成した後で、これらの項目を追加または更新できます。

PR のタイトルと説明を編集する

PR のタイトルと説明を最新の状態に保ち、校閲者が PR の変更を理解できるようにします。

既存の PR のタイトルを更新するには、現在のタイトルを選択し、テキストを更新します。 [保存] アイコンを選択して変更を保存するか、[元に戻す] アイコンを選択して変更を破棄します。

[説明] セクションの [編集 ] アイコンを選択して、PR の説明 を編集します。

P R タイトルの編集と説明の [編集] ボタンの選択を示すスクリーンショット。

pull request にレビュー担当者を追加する

新規または既存の PR の [校閲者 ] セクションにレビュー担当者を追加できます。 また、オプションの校閲者を必須に変更したり、必要なレビュー担当者を省略可能に変更したり、ポリシーで必須でない限り削除したりすることもできます。

ブランチ ポリシーでは、 最小限のレビュー担当者を必要 とするか、PR に特定のオプションまたは必須のレビュー担当者を自動的に含めることができます。 ブランチ ポリシーで必要な校閲者を削除することはできませんが、オプションの校閲者を必須に変更したり、削除したりすることはできます。

レビュー担当者を自動的に追加したブランチ ポリシーを表示するには、[PR の概要] ページの [校閲者] セクションで校閲の横にある [その他のオプション] を右クリックします。

ブランチ ポリシーによって自動的に含まれるレビュー担当者のポリシーの表示を示すスクリーンショット。

PR をレビューするユーザーまたはグループがプロジェクトのメンバーでない場合は、レビュー担当者として 追加する 前に、ユーザーまたはグループをプロジェクトに追加します。

レビュー担当者を新しい PR に追加するには、次の手順を実行します。

  1. [ 新しいプル要求 ] ページの [ 校閲者] で、[ユーザー とグループの検索] を選択してレビュー担当者として追加します
  2. 名前またはメール アドレスを入力すると、一致するユーザーとグループの一覧がドロップダウン リストに表示されます。 オプションのレビュー担当者として追加する名前を一覧から選択します。
  3. 必要な校閲者を追加するには、[ 必要な校閲者の追加] を選択し、[検索] を選択して検索する 必要のある校閲者を追加 し、名前を選択します。

新しい P R に校閲者を追加するスクリーンショット。

既存の PR にレビュー担当者を追加するには、次の手順を実行します。

  1. [概要] ページの [校閲者] セクションで、[追加] を選択し、[必須の校閲者] または [オプションの校閲者] を選択します。

    Pull request の概要

  2. 名前またはメール アドレスを入力すると、一致するユーザーまたはグループの一覧が表示されます。 レビュー担当者として追加する名前を選択します。

    P R レビュー担当者を追加します。

校閲者を必須と省略可能の間で変更したり、校閲者を削除したりするには、校閲者の名前の右側にある [ その他のオプション (⋮)] を選択します。 レビュー担当者として指定されたグループまたはチームのメンバーシップを表示するには、グループのアイコンを選択します。

作業項目を新しい PR にリンクするには、次の手順を実行します。

  1. [ 新しい pull request ] ページの [ リンクする作業項目] で、[ ID またはタイトルで作業項目を検索] を選択します。
  2. 作業項目 ID またはタイトルの入力を開始し、表示されるドロップダウン リストからリンクする作業項目を選択します。
    • タイトルで検索すると、状態でフィルター処理された作業項目が返されます。状態が [完了] と [ 削除 済み] に分類されているすべての作業項目は除外されます。
    • また、これらの作業項目は日付とユーザーによってフィルター処理され、過去 30 日間に作成または更新されたアイテムのみが表示されます。 これらは、現在のユーザーによって作成、割り当て、または現在のユーザーとして承認される必要があります。

作業項目を既存の PR にリンクするには、次の手順を実行します。

  1. [PR 概要 ] タブの [ 作業項目 ] 領域で、 +を選択します。

    [概要] タブと [作業項目] セクションの選択を示すスクリーンショット。

  2. 作業項目の ID を入力するか、作業項目のタイトルを検索します。 表示される一覧から作業項目を選択します。

作業項目の横にある x アイコンを選択して、作業項目のリンクを削除します。 リンクを削除すると、作業項目と PR の間のリンクのみが削除されます。 ブランチまたはコミットから作成されたリンクは、作業項目に残ります。

pull request にタグを追加する

タグを使用して重要な詳細を表示し、PR の整理に役立ちます。 タグは、PR がまだ進行中であるか、今後のリリースの修正プログラムであるなど、レビュー担当者に追加情報を伝えることができます。

タグ付きの RS を示すスクリーンショット。

PR の作成時にタグを追加するには、[ タグ ] セクションにタグ名を入力します。 PR を作成したら、[ タグ ] セクションでタグを管理できます。

[P R タグ] セクションが強調表示されているスクリーンショット。

プル要求に添付ファイルを追加する

作成中または作成後に、イメージを含むファイルを PR に添付できます。 [説明] フィールドの下にあるクリップ アイコンを選択するか、PR の [説明] フィールドにファイルを直接ドラッグ アンド ドロップします。

作成時に P R の説明にファイルを添付することを示すスクリーンショット。

アクティブなプル要求のターゲット ブランチを変更する

ほとんどのチームでは、ほぼすべての PR が既定のブランチ ( maindevelopなど) を対象としています。 別のブランチをターゲットにする必要がある場合は、PR の作成時にターゲット ブランチの変更を忘れるのが簡単です。 その場合は、アクティブな PR のターゲット ブランチを変更できます。

  1. [PR の概要] ページの右上にある [その他のアクション] を選択し、ドロップダウン メニューから [ターゲット ブランチの変更] を選択します。
  2. [ ターゲット ブランチの変更 ] ウィンドウで、[ ターゲット ブランチの選択] を選択し、新しいブランチを選択して、[ 変更] を選択します。

利害関係者に電子メール pull request 通知を送信する

pull request を電子メールで共有して、レビュー担当者に通知し、チーム メンバーとコミュニケーションを取ることができます。 PR を共有するには:

  1. [PR の概要] ページで [その他のオプション] を選択し、[プル要求の共有] を選択します。

    P R の [概要] ページで [プル要求の共有] を選択していることを示すスクリーンショット。

  2. [ 共有プル要求 ] 画面で、[ 宛先] フィールドに名前を入力し、表示されるユーザー名から選択して受信者を追加します。 受信者を削除することもできます。

  3. [ メモ] (省略可能) フィールドに省略可能なメッセージを追加し、[ 送信] を選択します。 受信者は、注意を求める電子メールを受信し、PR にリンクします。

組み込みの電子メール機能を使用する場合は、個々のプロジェクト メンバーのアドレスにのみメールを送信できます。 To: 行へのチーム グループまたはセキュリティ グループの追加はサポートされていません。 認識できないメール アドレスを追加すると、1 人以上の受信者がメールで送信されたプル要求を読み取るアクセス許可を持っていないことを示すメッセージが表示されます。

電子メール機能を機能させるには、管理者が SMTP サーバーを構成する必要があります。

次のステップ