プルリクエストの作成 - Amazon CodeCatalyst

プルリクエストの作成

プルリクエストを作成すると、他のユーザーがコード変更を他のブランチにマージする前にそのコードの変更を確認するのに役立ちます。まず、コード変更のためのブランチを作成します。これは、プルリクエストのソースブランチとして参照されます。変更をコミットしてリポジトリにプッシュしたら、ソースブランチの内容とターゲットブランチの内容を比較するプルリクエストを作成します。

Amazon CodeCatalyst コンソールで、特定のブランチ、プルリクエストページ、またはプロジェクトの概要からプルリクエストを作成します。特定のブランチからプルリクエストを作成すると、リポジトリ名とソースブランチがプルリクエストの作成ページに自動的に表示されます。プルリクエストを作成すると、プルリクエストの更新時や、プルリクエストがマージまたは閉じられたときに、自動的に E メールが送信されます。

注記

プルリクエストの作成時に表示される違いは、ソースブランチの先端とターゲットブランチの先端の間の違いです。プルリクエストの作成後に表示される違いは、選択したプルリクエストのリビジョンと、プルリクエストの作成時にターゲットブランチの先端であったコミットの間の違いです。Git の違いとマージベースの詳細については、Git ドキュメントの「git-merge-base」を参照してください。

プルリクエストを作成するときに「説明を記述する」機能を使用すると、プルリクエストに含まれる変更の説明が Amazon Q によって自動的に作成されます。このオプションを選択すると、Amazon Q はコード変更を含むソースブランチと、変更のマージするターゲットブランチの違いを分析します。その後、変更内容の要約と、変更の意図と影響に関する最善の解釈を作成します。この機能は、米国西部 (オレゴン) リージョンの CodeCatalyst プルリクエストでのみ使用できます。リンクされたリポジトリのプルリクエストでは、説明を記述する機能は使用できません。

注記
注記

Amazon Bedrock を搭載: AWS は不正使用の自動検出を実装します。Amazon Q Developer Agent for Software Development の「説明を記述する」、「内容の要約を作成する」、「タスクを提案する」、「Amazon Q を使用してプロジェクトに機能を作成または追加する」、「Amazon Q に問題を割り当てる」機能は Amazon Bedrock を基盤に構築されているため、ユーザーは Amazon Bedrock に実装されている統制を最大限に活用して、AI の安全性、セキュリティ、責任ある使用を徹底することができます。

プルリクエストを作成するには

  1. プロジェクトに移動します。

  2. 次のいずれかを行います。

    • ナビゲーションペインで、[コード]、[プルリクエスト]、[プルリクエストを作成] の順に選択します。

    • リポジトリのホームページで、[その他]、[プルリクエストの作成] の順に選択します。

    • [プロジェクト] ページで、[プルリクエストを作成] を選択します。

  3. [ソールリポジトリ] で、指定したソースリポジトリがコミットしたコードを含むリポジトリであることを確認します。このオプションは、リポジトリのメインページでプルリクエストを作成しなかった場合のみに表示されます。

  4. [ターゲットブランチ] で、コードのレビュー後、マージ先となるブランチを選択します。

  5. [ソースブランチ] でコミットしたコードを含むブランチを選択します。

  6. [プルリクエストのタイトル] に、ユーザーが確認すべき内容と理由が理解しやすい件名を入力します。

  7. (オプション) [プルリクエストの説明] で、問題へのリンクや変更の説明などの情報を入力します。

    ヒント

    [説明を記述する] を選択すると、プルリクエストに含まれる変更の説明を CodeCatalyst が自動生成します。自動的に生成された説明は、プルリクエストに追加した後で変更できます。

    この機能を使用するには、生成 AI 機能がスペースで有効になっている必要があります。また、リンクされたリポジトリのプルリクエストでは使用できません。詳細については、「Managing generative AI features」を参照してください。

  8. (オプション) [問題] で、[問題のリンク] を選択し、リストから問題を選択するか、その ID を入力します。問題のリンクを解除するには、リンク解除アイコンを選択します。

  9. (オプション) [必須のレビュアー] で、[必須のレビュアーを追加] を選択します。プロジェクトメンバーのリストから、追加するメンバーを選択します。プルリクエストをターゲットブランチにマージする前に、必須のレビュアーが変更を承認する必要があります。

    注記

    同じレビュアーを必須のレビュアーと任意のレビュアーの両方に追加することはできません。自分をレビュアーとして追加することはできません。

  10. (オプション) [任意のレビュアー] で、[任意のレビュアーを追加] を選択します。プロジェクトメンバーのリストから、追加するメンバーを選択します。任意のレビュアーは、プルリクエストをターゲットブランチにマージする前に、変更を要件として承認する必要はありません。

  11. ブランチの違いを確認します。プルリクエストに表示される違いは、ソースブランチのリビジョンと、マージベース (プルリクエストの作成時のターゲットブランチのヘッドコミット) の間の変更です。変更が表示されない場合、ブランチがまったく同じであるか、ソースとターゲットの両方に同じブランチを選択している可能性があります。

  12. プルリクエストに必要なコードと変更が含まれていることを確認したら、[作成] を選択します。

    注記

    プルリクエストを作成したら、コメントを追加できます。コメントは、プルリクエスト、またはファイルの各行、およびプルリクエスト全体に追加できます。ファイルなどのリソースへのリンクは、@ 記号の後にファイルの名前を付けることで追加できます。

ブランチからプルリクエストを作成するには

  1. プルリクエストを作成するプロジェクトに移動します。

  2. ナビゲーションペインで、[ソースリポジトリ] を選択し、レビューするコード変更があるブランチを含むリポジトリを選択します。

  3. デフォルトのブランチ名の横にあるドロップダウン矢印を選択し、リストから必要なブランチを選択します。リポジトリのすべてのブランチを表示するには、[すべて表示] を選択します。

  4. [詳細] を選択し、[プルリクエストを作成] を選択します。

  5. リポジトリとソースブランチが事前に選択されています。[ターゲットブランチ] で、レビュー後にコードをマージするブランチを選択します。[プルリクエストのタイトル] にタイトルを入力し、他のプロジェクトユーザーがレビューの内容と理由を理解できるようにします。必要に応じて、[プルリクエストの説明] に詳細情報を入力します。例えば、CodeCatalyst の関連する問題へのリンクを貼り付けたり、行った変更の説明を追加したりできます。

    注記

    プルリクエストの作成イベントに対して実行するように設定されたワークフローは、プルリクエストのターゲットブランチがワークフローで指定されたブランチのいずれかと一致する場合に、プルリクエストの作成後に実行されます。

  6. ブランチの違いを確認します。変更が表示されない場合、ブランチが同じであるか、ソースとターゲットの両方に同じブランチを選択している可能性があります。

  7. (オプション) [問題] で、[問題のリンク] を選択し、リストから問題を選択するか、その ID を入力します。問題のリンクを解除するには、リンク解除アイコンを選択します。

  8. (オプション) [必須のレビュアー] で、[必須のレビュアーを追加] を選択します。プロジェクトメンバーのリストから、追加するメンバーを選択します。プルリクエストをターゲットブランチにマージする前に、必須のレビュアーが変更を承認する必要があります。

    注記

    同じレビュアーを必須のレビュアーと任意のレビュアーの両方に追加することはできません。自分をレビュアーとして追加することはできません。

  9. (オプション) [任意のレビュアー] で、[任意のレビュアーを追加] を選択します。プロジェクトメンバーのリストから、追加するメンバーを選択します。任意のレビュアーは、プルリクエストをターゲットブランチにマージする前に、変更を承認する必要はありません。

  10. プルリクエストに必要な変更と必須のレビュアーが含まれていることを確認したら、[作成] を選択します。

プルリクエストのターゲットブランチと一致するブランチで実行するように設定されたワークフローがある場合、プルリクエストの作成後に、それらのワークフロー実行に関する情報が、[プルリクエストの詳細] エリアの [概要] に表示されます。詳細については、「ワークフローへのトリガーの追加」を参照してください。