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

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

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

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

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

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

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

注記

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

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

以下を使用できます。 CodeCommit コンソールを使用して、コミットに関するコメントを表示します。

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

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

  2. リポジトリ、コミットに関するコメントを確認するリポジトリを選択します。

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

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

リポジトリ内のコミットに関するコメントの追加と返信

以下を使用できます。 CodeCommit コンソールを使用して、コミットと親の比較、または2つの指定されたコミットの比較にコメントを追加します。コメントには、絵文字、自分のコメント、またはその両方で返信することもできます。

コミット(コンソール)に関するコメントに追加して返信する

テキストと絵文字でコミットにコメントを追加したり、コメントに返信したりできます。コメントと絵文字は、 IAM ユーザーまたはロール。

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

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

  2. リポジトリ、コミットについてコメントするリポジトリを選択します。

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

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

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

    • 一般コメントを追加するには、 変更に関するコメント、コメントを入力してから、 保存. 以下を使用できます。 値下げまたは、コメントをプレーンテキストで入力できます。

      
                  コミットの変更についての全般的なコメント。
    • コミット内のファイルにコメントを追加するには、ファイルの名前を見つけます。選択 ファイルのコメント、コメントを入力してから、 保存.

      
                  コミット内のファイルにコメントを追加する。
    • コミット内の変更された行にコメントを追加するには、変更が表示される行に移動します。コメントバブルを選択 、コメントを入力してから、 保存.

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

    コメントは、保存後に編集できます。その内容を削除することもできます。コメントには、内容が削除されたことを示すメッセージが残ります。使用を検討する マークダウンのプレビュー コメントを保存する前に、コメントのモードにします。

  5. コミットに関するコメントに返信するには、 返信. 絵文字でコメントに返信するには、リストから絵文字を選択します。1つのコメントにつき1つの絵文字しか選択できません。絵文字の反応を変更する場合は、リストから別のものを選択するか、 なし 反応を取り除いてください

    
            コメントへの返信や絵文字の反応の追加。

2 つのコミット指定子を比較する場合、コメントを追加してコメントに返信します

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

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

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

  2. リポジトリ、コミット、ブランチ、またはタグ付けされたコミットを比較するリポジトリを選択します。

  3. ナビゲーションペインで、 コミットを選択し、次に コミットを比較 タブ。

    
              2 つのコミット指定子を比較
  4. _を使用 目的地 および ソース フィールドを使用して、2 つのコミット指定子を比較します。ドロップダウンリストを使用するか、コミット ID を貼り付けます。選択 比較.

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

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

    • 比較した変更について一般的なコメントを追加するには、 変更に関するコメント.

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

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

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

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

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

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

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

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

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

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

    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
    注記

    コメントのコンテンツのみ削除できます。 Nutanixの 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 属性を指定)。

    たとえば、"Can you add a test case for this?" 変更について cl_sample.js リポジトリ内の2つのコミットの比較ファイル MyDemoRepo:

    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 コマンドを実行します。

    たとえば、"Fixed as requested. I'll update the pull request." 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 オプションを指定)。

    たとえば、"Good catch. I'll remove them." システム生成の 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

    たとえば、絵文字を追加するには、:thumbsup: システム生成の ID を持つコメントへ abcd1234EXAMPLEb5678efgh:

    aws codecommit put-comment-reaction --comment-id abcd1234EXAMPLEb5678efgh --reaction-value :thumbsup:
  2. このコマンドに成功すると、出力は生成されません。

コメントに対する絵文字の反応を表示するには

  1. コメントに対する絵文字の反応を表示するには、 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" ] } ] } }