AWS CodeCommit でコミットにコメントする - AWS CodeCommit

AWS CodeCommit でコミットにコメントする

CodeCommit コンソールを使用して、リポジトリのコミットについてコメントしたり、コミットについての他のユーザーのコメントを表示してそれに返答することができます。これにより、以下の点を含め、リポジトリに加えられた変更について検討しやすくなります。

  • なぜ変更が行われたか。

  • 変更がさらに必要かどうか。

  • 変更が別のブランチにマージされる必要があるか。

コメントは、コミット全体、コミット内のファイル、またはファイル内の特定の行や変更に対して行うことができます。コードの 1 行または複数行へのリンクを作成することもできます。そのためには、1 行または複数行を選択して、ブラウザに表示される URL をコピーします。

注記

最良の結果を得るには、IAM ユーザーとしてログインしているときにコメントを使用します。このコメント機能は、ルートアカウント認証情報、フェデレーティッドアクセスまたは一時的な認証情報を使用してサインインするユーザーには最適化されていません。

リポジトリのコミットに対するコメントを表示する

CodeCommit コンソールを使用して、コミットのコメントを表示します。

コミットについてのコメントを表示するには

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

  2. [リポジトリ] で、コミットのコメントを表示するレポジトリを選択します。

  3. ナビゲーションペインで、[Commits] を選択します。コメントを表示するコミットのコミット ID を選択します。

    そのコミットのページがコメントとともに表示されます。

リポジトリのコミットに対するコメントの追加またはコメントへの応答

CodeCommit コンソールを使用して、コミットと親の比較や指定した 2 つのコミットの比較にコメントを追加することができます。また、絵文字、各自のコメント、その両方を使用してコメントに応答することもできます。

コミットにコメントを追加したり、コメントに応答したりする (コンソール)

テキストと絵文字を使用してコミットにコメントを追加したり、コメントに応答したりできます。コメントや絵文字は、コンソールへのサインインに使用した IAM ユーザーやロールに属するものとしてマークされます。

コミットについてのコメントの追加や返答をするには

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

  2. [リポジトリ] で、コミットにコメントするレポジトリを選択します。

  3. ナビゲーションペインで、[Commits] を選択します。コメントを追加、またはコメントに返信するコミットのコミット ID を選択します。

    そのコミットのページがコメントとともに表示されます。

  4. コメントを追加するには、以下のいずれかを実行します。

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

      
                  コミットの変更についての全般的なコメント。
    • コミット内のファイルにコメントを追加するには、ファイルの名前を見つけます。[Comment on file (ファイルに関するコメント)] を選択してコメントを入力し、[保存] を選択します。

      
                  コミット内のファイルにコメントを追加する。
    • コミット内の変更された行にコメントを追加するには、変更が表示される行に移動します。コメント用吹き出し ( ) を選択してコメントを入力し、[保存] を選択します。

      
                  コミット内の行にコメントを追加する。
    注記

    コメントは、保存後に編集できます。その内容を削除することもできます。コメントには、内容が削除されたことを示すメッセージが残ります。保存する前にコメントの [Preview markdown] モードの使用を検討してください。

  5. コミットへのコメントに返信するには、[Reply] を選択します。絵文字を使用してコメントに返信するには、リストから目的の絵文字を選択します。1 つのコメントにつき 1 つの絵文字のみ選択できます。絵文字リアクションを変更する場合は、リストから別のリアクションを選択するか、[なし] を選択してリアクションを削除します。

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

2 つのコミット指定子を比較する際のコメントの追加とコメントへの返答

ブランチ間、タグ間、またはコミット間の比較にコメントを追加できます。

コミット指定子の比較時にコメントの追加または返信を行うには

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

  2. [リポジトリ] ページで、リポジトリのリストから、コミット、ブランチ、またはタグ付きコミットを比較するリポジトリを選択します。

  3. ナビゲーションペインで、[コミット]、[コミットの比較] タブの順に選択します。

    
              2 つのコミット指定子を比較
  4. 2 つのコミット指定子を比較するには、[送信先] フィールドおよび [送信元] フィールドを使用します。ドロップダウンリストを使用するか、コミット ID を貼り付けます。[Compare] を選択します。

    
              ブランチのコミット ID 比較時のサンプル結果
  5. 次の 1 つ以上の操作を行います。

    • ファイルまたは行にコメントを追加するには、コメント用吹き出し を選択します。

    • 比較された変更について全般的なコメントを追加するには、[Comments on changes] に移動します。

コメントの表示、追加、更新、返信 (AWS CLI)

コマンドの内容を表示、返信、更新、および削除するには、次のコマンドを実行します。

コミットについてのコメントを表示するには

  1. 次のように指定して get-comments-for-compared-commit コマンドを実行します。

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

    • 比較の方向性を確立するためのコミット後のフルコミット ID (--after-commit-id option を使用)。

    • 比較の方向性を確立するためのコミット前のフルコミット ID (--before-commit-id オプションを使用)。

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

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

    たとえば、MyDemoRepo という名前のリポジトリで 2 つのコミット間の比較に対して作成されたコメントを表示するには、次の操作を行います。

    aws codecommit get-comments-for-compared-commit --repository-name MyDemoRepo --before-commit-ID 6e147360EXAMPLE --after-commit-id 317f8570EXAMPLE
  2. このコマンドが正常に実行されると、次のような出力が生成されます。

    { "commentsForComparedCommitData": [ { "afterBlobId": "1f330709EXAMPLE", "afterCommitId": "317f8570EXAMPLE", "beforeBlobId": "80906a4cEXAMPLE", "beforeCommitId": "6e147360EXAMPLE", "comments": [ { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "123Example", "commentId": "ff30b348EXAMPLEb9aa670f", "content": "Whoops - I meant to add this comment to the line, not the file, but I don't see how to delete it.", "creationDate": 1508369768.142, "deleted": false, "CommentId": "123abc-EXAMPLE", "lastModifiedDate": 1508369842.278, "callerReactions": [], "reactionCounts": { "SMILE" : 6, "THUMBSUP" : 1 } }, { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "123Example", "commentId": "553b509bEXAMPLE56198325", "content": "Can you add a test case for this?", "creationDate": 1508369612.240, "deleted": false, "commentId": "456def-EXAMPLE", "lastModifiedDate": 1508369612.240, "callerReactions": [], "reactionCounts": { "THUMBSUP" : 2 } } ], "location": { "filePath": "cl_sample.js", "filePosition": 1232, "relativeFileVersion": "after" }, "repositoryName": "MyDemoRepo" } ], "nextToken": "exampleToken" }

コミットに対するコメントの詳細を表示するには

  1. システムによって生成されたコメント ID を指定して、get-comment コマンドを実行します。例:

    aws codecommit get-comment --comment-id ff30b348EXAMPLEb9aa670f
  2. 成功すると、このコマンドは以下のような出力を返します。

    { "comment": { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "123Example", "commentId": "ff30b348EXAMPLEb9aa670f", "content": "Whoops - I meant to add this comment to the line, but I don't see how to delete it.", "creationDate": 1508369768.142, "deleted": false, "commentId": "", "lastModifiedDate": 1508369842.278, "callerReactions": [], "reactionCounts": { "SMILE" : 6, "THUMBSUP" : 1 } } }

コミットに対するコメントの内容を削除するには

  1. システムによって生成されたコメント ID を指定して、delete-comment-content コマンドを実行します。例:

    aws codecommit delete-comment-content --comment-id ff30b348EXAMPLEb9aa670f
    注記

    コメントの内容を削除できるのは、AWSCodeCommitFullAccess ポリシーが適用されているか、DeleteCommentContent アクセス許可が [許可] に設定されている場合のみです。

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

    { "comment": { "creationDate": 1508369768.142, "deleted": true, "lastModifiedDate": 1508369842.278, "clientRequestToken": "123Example", "commentId": "ff30b348EXAMPLEb9aa670f", "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "callerReactions": [], "reactionCounts": { "CLAP" : 1 } } }

コミットに対するコメントを作成するには

  1. 次のように指定して post-comment-for-compared-commit コマンドを実行します。

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

    • 比較の方向性を確立するためのコミット後のフルコミット ID (--after-commit-id オプションを使用)。

    • 比較の方向性を確立するためのコミット前のフルコミット ID (--before-commit-id オプションを使用)。

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

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

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

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

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

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

    たとえば、MyDemoRepo という名前のリポジトリで、2 つのコミット間の比較に対して、cl_sample.js ファイルへの変更でコメント (「これにテストケースを追加できますか?」) を追加するには、次のように行います。

    aws codecommit post-comment-for-compared-commit --repository-name MyDemoRepo --before-commit-id 317f8570EXAMPLE --after-commit-id 5d036259EXAMPLE --client-request-token 123Example --content "Can you add a test case for this?" --location filePath=cl_sample.js,filePosition=1232,relativeFileVersion=AFTER
  2. このコマンドが正常に実行されると、次のような出力が生成されます。

    { "afterBlobId": "1f330709EXAMPLE", "afterCommitId": "317f8570EXAMPLE", "beforeBlobId": "80906a4cEXAMPLE", "beforeCommitId": "6e147360EXAMPLE", "comment": { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "", "commentId": "553b509bEXAMPLE56198325", "content": "Can you add a test case for this?", "creationDate": 1508369612.203, "deleted": false, "commentId": "abc123-EXAMPLE", "lastModifiedDate": 1508369612.203, "callerReactions": [], "reactionCounts": [] }, "location": { "filePath": "cl_sample.js", "filePosition": 1232, "relativeFileVersion": "AFTER" }, "repositoryName": "MyDemoRepo" }

コミットに対するコメントを更新するには

  1. システムによって生成された ID と、既存のコンテンツと置き換えるコンテンツを指定して、update-comment コマンドを実行します。

    たとえば、「リクエストどおり修正しました。プルリクエストを更新します」という内容を、ID が 442b498bEXAMPLE5756813 のコメントに追加するには、次のようにします。

    aws codecommit update-comment --comment-id 442b498bEXAMPLE5756813 --content "Fixed as requested. I'll update the pull request."
  2. このコマンドが正常に実行されると、次のような出力が生成されます。

    { "comment": { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "", "commentId": "442b498bEXAMPLE5756813", "content": "Fixed as requested. I'll update the pull request.", "creationDate": 1508369929.783, "deleted": false, "lastModifiedDate": 1508369929.287, "callerReactions": [], "reactionCounts": { "THUMBSUP" : 2 } } }

コミットに対するコメントに返信するには

  1. プルリクエストのコメントに返答するには、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
  2. このコマンドが正常に実行されると、次のような出力が生成されます。

    { "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, "CommentId": "abcd1234EXAMPLEb5678efgh", "lastModifiedDate": 150836912.221, "callerReactions": [], "reactionCounts": [] } }

絵文字を使用してコミットのコメントに返信するには

  1. 絵文字を使用してプルリクエストのコメントに返信したり、絵文字リアクションの値を変更したりするには、put-comment-reaction コマンドを実行し、以下を指定します。

    • 絵文字を使用して返信する対象のコメントの、システムによって生成された ID。

    • 追加または更新するリアクションの値。値として、サポートされている絵文字、ショートコード、Unicode 値を使用できます。

    CodeCommit では、絵文字として以下の値がサポートされています。

    絵文字 ショートコード Unicode

    :thumbsup:

    U+1F44D

    :thumbsdown:

    U+1F44E

    :smile:

    U+1F604

    :heart:

    U+2764

    :angry:

    U+1F620

    :confused:

    U+1F615

    :scream:

    U+1F631

    :sob:

    U+1F62D

    :clap:

    U+1F44F

    :confetti_ball:

    U+1F38A

    :ship:

    U+1F6A2

    :eyes:

    U+1F440

    なし

    U+0000

    例えば、絵文字として親指を上げた手を、システムによって生成された ID が abcd1234EXAMPLEb5678efgh のコメントに追加するには、次のようにします。

    aws codecommit put-comment-reaction --comment-id abcd1234EXAMPLEb5678efgh --reaction-value :thumbsup:
  2. このコマンドが成功した場合、出力は生成されません。

コメントへの絵文字リアクションを表示するには

  1. コメントへの絵文字リアクション (これらの絵文字に反応したユーザーを含む) を表示するには、システムによって生成されたコメントの ID を指定して、get-comment-reactions コマンドを実行します。

    例えば、システムによって生成された ID が abcd1234EXAMPLEb5678efgh のコメントへの絵文字リアクションを表示するには、次のようにします。

    aws codecommit get-comment-reactions --comment-id abcd1234EXAMPLEb5678efgh
  2. このコマンドが正常に実行されると、次のような出力が生成されます。

    { "reactionsForComment": { [ { "reaction": { "emoji:"👍", "shortCode": "thumbsup", "unicode": "U+1F44D" }, "users": [ "arn:aws:iam::123456789012:user/Li_Juan", "arn:aws:iam::123456789012:user/Mary_Major", "arn:aws:iam::123456789012:user/Jorge_Souza" ] }, { "reaction": { "emoji": "👎", "shortCode": "thumbsdown", "unicode": "U+1F44E" }, "users": [ "arn:aws:iam::123456789012:user/Nikhil_Jayashankar" ] }, { "reaction": { "emoji": "😕", "shortCode": "confused", "unicode": "U+1F615" }, "users": [ "arn:aws:iam::123456789012:user/Saanvi_Sarkar" ] } ] } }