プルリクエストのレビュー - AWS CodeCommit

AWS CodeCommit は、新しいお客様では利用できなくなりました。 AWS CodeCommit の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

プルリクエストのレビュー

AWS CodeCommit コンソールを使用して、プルリクエストに含まれる変更を確認できます。コメントは、リクエスト、ファイル、個別のコード行に追加できます。他のユーザーのコメントに返信することもできます。リポジトリが configured with notifications と設定されている場合、ユーザーがコメントに返信するとき、またはプルリクエストにユーザーがコメントするときに E メールで通知が送信されます。

を使用してプルリクエストに AWS CLI コメントし、コメントに返信できます。変更を確認するには、 CodeCommit コンソール、 git diff コマンド、または差分ツールを使用する必要があります。

プルリクエストを確認する (コンソール)

CodeCommit コンソールを使用して、 CodeCommit リポジトリ内のプルリクエストを確認できます。

  1. https://console.aws.amazon.com/codesuite/codecommit/home で CodeCommit コンソールを開きます。

  2. リポジトリで、リポジトリの名前を選択します。

  3. ナビゲーションペインで、[プルリクエスト] を選択します。

  4. デフォルトでは、すべてのオープンプルリクエストが一覧表示されます。確認したいオープンプルリクエストを選択します。

    CodeCommit コンソールに表示されるオープンプルリクエスト。
    注記

    クローズまたはマージされたプルリクエストにコメントすることはできますが、マージまたは再度開くことはできません。

  5. プルリクエストで、[Changes] を選択します。

  6. 次のいずれかを行ってください。

    • プルリクエスト全体に全般的なコメントを追加するには、[Comments on changes (変更に関するコメント)] や [New comment (新規コメント)] にコメントを入力して、[Save (保存)] を選択します。マークダウンを使用するか、プレーンテキスト形式でコメントを入力します。

      プルリクエストの変更に対する全般的なコメント。
    • コミット内のファイルにコメントを追加するには、[Changes] でファイルの名前を見つけます。ファイル名の横に表示されるコメント用アイコン ( The comment bubble icon that that indicates that you can leave a comment on that line of code. ) を選択し、コメントを入力して [保存] を選択します。

      プルリクエスト内のファイルに対するコメントの追加。
    • プルリクエスト内の変更された行にコメントを追加するには、[Changes] でコメントする行に移動します。その行の横に表示されるコメント用アイコン ( The comment bubble icon that that indicates that you can leave a comment on that line of code. ) を選択し、コメントを入力して [保存] を選択します。

      プルリクエスト内の行に対するコメントの追加。
  7. コミットのコメントに返信するには、[Changes] または [Activity] で、[Reply] を選択します。テキストと絵文字を使用して返信できます。

    コメントへの返信や絵文字リアクションの追加。

    特定の絵文字リアクションを使用して応答したユーザーの名前を、その絵文字リアクションを選択して表示できます。すべての絵文字リアクションと、特定の絵文字を使用して応答したユーザーに関する情報を表示するには、[View all reactions (すべてのリアクションを表示)」を選択します。コメントに絵文字で応答した場合、その応答は絵文字リアクションボタンのアイコンに表示されます。

    注記

    コンソールに表示されるリアクション数は、ページが読み込まれた時点で正確です。絵文字のリアクション数に関する最新情報を表示するには、ページを更新するか、[View all reactions (すべてのリアクションを表示)] を選択します。

    絵文字リアクションを使用してコメントに応答したユーザーに関する情報の表示。
  8. (オプション) レコメンデーションの品質に関するフィードバックを提供するなど、Amazon CodeGuru Reviewer によって作成されたレコメンデーションに返信するには、「返信」を選択します。リアクションボタンを使用して、推奨事項を承認するかどうかに関する一般的な情報を提供します。コメントフィールドを使用して、リアクションの詳細を入力します。

    注記

    Amazon CodeGuru Reviewer は、プログラム分析と機械学習を使用して一般的な問題を検出し、Java または Python コードの修正を推奨する自動コードレビューサービスです。

    • Amazon CodeGuru Reviewer コメントは、リポジトリを Amazon CodeGuru Reviewer に関連付けている場合、分析が完了した場合、プルリクエストのコードが Java または Python コードである場合にのみ表示されます。詳細については、「リポジトリと AWS CodeCommit Amazon CodeGuru Reviewer の関連付けまたは関連付け解除」を参照してください。

    • Amazon CodeGuru Reviewer のコメントは、プルリクエストの最新のリビジョンに対してコメントが行われた場合にのみ、変更タブに表示されます。[アクティビティ] タブには、コメントが常に表示されます。

    • Amazon CodeGuru Reviewer のレコメンデーションに対して使用可能な絵文字リアクションのいずれかで応答できますが、レコメンデーションの有用性を評価するには、親指を上げた絵文字リアクションと親指を下げた絵文字リアクションのみが使用されます。

    Amazon CodeGuru Reviewer によって作成され、レビュージョブが進行中のレコメンデーション。
  9. プルリクエストで行われた変更を承認するには、[Approve (承認)] を選択します。

    注記

    自分で作成したプルリクエストを自分で承認することはできません。

    承認、プルリクエストの承認ルール、および承認ルールテンプレートによって作成された承認ルールを [Approvals (承認)] で表示できます。プルリクエストを承認しない場合は、[Revoke approval (承認の取り消し)] を選択できます。

    注記

    承認または取り消すことができるのは、オープンプルリクエストの承認のみです。ステータスが「マージ済」または「クローズ」のプルリクエストでは、承認を承認または取り消すことはできません。

    プルリクエストの承認と承認ルール。

プルリクエストを確認する (AWS CLI)

で AWS CLI コマンドを使用するには CodeCommit、 をインストールします AWS CLI。詳細については、「コマンドラインリファレンス」を参照してください。

プルリクエストは、次の AWS CLI コマンドで確認できます。

次のコマンドを使用して、プルリクエストでコメントに絵文字を付けることもできます。

  • 絵文字を使用してコメントに返信するには、put-comment-reaction を実行します。

  • コメントへの絵文字リアクションを表示するには、get-comment-reactions を実行します。

を使用して CodeCommit リポジトリのプルリクエスト AWS CLI を確認するには

  1. リポジトリのプルリクエストにコメントを追加するには、post-comment-for-pull-request コマンドを実行し、以下を指定します。

    • プルリクエストの ID (--pull-request-id オプションを指定)。

    • プルリクエストが含まれているリポジトリの名前 (--repository-name オプションで指定)。

    • プルリクエストのマージ先である送信先ブランチのコミットの完全なコミット ID (--before-commit-id オプションで指定)。

    • コメントの投稿時にプルリクエストでブランチの現在の先端となっている送信元ブランチのコミットの完全なコミット ID (--after-commit-id オプションで指定)。

    • 冪等性の一意、クライアントで生成されたトークン (--client-request-token オプションを指定)。

    • コメントのコンテンツ (--content オプションを指定)。

    • コメントの配置場所に関する場所情報のリストには、以下を含みます。

      • 拡張子やサブディレクトリなど、比較されているファイルの名前 (ある場合) (filePath 属性を指定)。

      • 比較ファイル内の変更の行番号 (filePosition 属性を指定)。

      • 送信元ブランチと送信先ブランチの比較で、変更のコメントが「前」か「後」か (relativeFileVersion 属性を指定)。

    たとえば、このコマンドを使用して、「これらは、どこでも使用されていないようです。削除できますか。」 という名前のリポジトリの ID が 47 のプルリクエストの ahs_count.py ファイルへの変更MyDemoRepo

    aws codecommit post-comment-for-pull-request --pull-request-id "47" --repository-name MyDemoRepo --before-commit-id 317f8570EXAMPLE --after-commit-id 5d036259EXAMPLE --client-request-token 123Example --content "These don't appear to be used anywhere. Can we remove them?" --location filePath=ahs_count.py,filePosition=367,relativeFileVersion=AFTER

    このコマンドが正常に実行されると、次のような出力が生成されます。

    { "afterBlobId": "1f330709EXAMPLE", "afterCommitId": "5d036259EXAMPLE", "beforeBlobId": "80906a4cEXAMPLE", "beforeCommitId": "317f8570EXAMPLE", "comment": { "authorArn": "arn:aws:iam::111111111111:user/Saanvi_Sarkar", "clientRequestToken": "123Example", "commentId": "abcd1234EXAMPLEb5678efgh", "content": "These don't appear to be used anywhere. Can we remove them?", "creationDate": 1508369622.123, "deleted": false, "lastModifiedDate": 1508369622.123, "callerReactions": [], "reactionCounts": [] } "location": { "filePath": "ahs_count.py", "filePosition": 367, "relativeFileVersion": "AFTER" }, "repositoryName": "MyDemoRepo", "pullRequestId": "47" }
  2. プルリクエストのコメントを表示するには、get-comments-for-pull-request コマンドを実行し、以下を指定します。

    • CodeCommit リポジトリの名前 ( --repository-nameオプションを指定)。

    • プルリクエストのシステム生成の ID (--pull-request-id オプション付き)。

    • (オプション) 結果の次のバッチを返す列挙トークン (--next-token オプションを使用)。

    • (オプション) 返される結果の数を制限する負でない整数 (--max-results オプションを使用)。

    たとえば、ID が 42 のプルリクエストのコメントを表示するには、このコマンドを使用します。

    aws codecommit get-comments-for-pull-request --pull-request-id 42

    このコマンドが正常に実行されると、次のような出力が生成されます。

    { "commentsForPullRequestData": [ { "afterBlobId": "1f330709EXAMPLE", "afterCommitId": "5d036259EXAMPLE", "beforeBlobId": "80906a4cEXAMPLE", "beforeCommitId": "317f8570EXAMPLE", "comments": [ { "authorArn": "arn:aws:iam::111111111111:user/Saanvi_Sarkar", "clientRequestToken": "", "commentId": "abcd1234EXAMPLEb5678efgh", "content": "These don't appear to be used anywhere. Can we remove them?", "creationDate": 1508369622.123, "deleted": false, "lastModifiedDate": 1508369622.123, "callerReactions": [], "reactionCounts": { "THUMBSUP" : 6, "CONFUSED" : 1 } }, { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "", "commentId": "442b498bEXAMPLE5756813", "content": "Good catch. I'll remove them.", "creationDate": 1508369829.104, "deleted": false, "lastModifiedDate": 150836912.273, "callerReactions": ["THUMBSUP"] "reactionCounts": { "THUMBSUP" : 14 } } ], "location": { "filePath": "ahs_count.py", "filePosition": 367, "relativeFileVersion": "AFTER" }, "repositoryName": "MyDemoRepo", "pullRequestId": "42" } ], "nextToken": "exampleToken" }
  3. プルリクエストを承認するか取り消すには、次を指定して、update-pull-request-approval-state コマンドを実行します。

    • プルリクエストの ID (--pull-request-id オプションを指定)。

    • プルリクエストのリビジョン ID (--revision-id option) を使用。get-pull-request コマンドを使用して、プルリクエストの現在のリビジョン ID を取得できます。

    • 適用する承認状態(--approval-state を使用)。有効な承認状態には、APPROVE および REVOKE があります。

    たとえば、ID が 27 で、リビジョン ID が 9f29d167EXAMPLE のプルリクエストを承認するには、このコマンドを使用します。

    aws codecommit update-pull-request-approval-state --pull-request-id 27 --revision-id 9f29d167EXAMPLE --approval-state "APPROVE"

    成功すると、このコマンドは何も返しません。

  4. プルリクエストのコメントに返答するには、post-comment-reply コマンドを実行して、次のように指定します。

    • 返信したいコメントのシステム生成 ID (--in-reply-to オプションを指定)。

    • 冪等性の一意、クライアントで生成されたトークン (--client-request-token オプションを指定)。

    • 返答のコンテンツ (--content オプションを指定)。

    たとえば、このコマンドを使用して、「よく見つけましたね。削除します。」 という返答を、システムによって生成された ID が abcd1234EXAMPLEb5678efgh のコメントに追加する場合。

    aws codecommit post-comment-reply --in-reply-to abcd1234EXAMPLEb5678efgh --content "Good catch. I'll remove them." --client-request-token 123Example

    このコマンドが正常に実行されると、次のような出力が生成されます。

    { "comment": { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "123Example", "commentId": "442b498bEXAMPLE5756813", "content": "Good catch. I'll remove them.", "creationDate": 1508369829.136, "deleted": false, "lastModifiedDate": 150836912.221, "callerReactions": [], "reactionCounts": [] } }