CodeCommit exemples utilisant AWS CLI - AWS Command Line Interface
Actions

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

CodeCommit exemples utilisant AWS CLI

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide du AWS Command Line Interface with CodeCommit.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous montrent comment appeler des fonctions de service individuelles, vous pouvez les visualiser dans leur contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

L'exemple de code suivant montre comment utiliserassociate-approval-rule-template-with-repository.

AWS CLI

Pour associer un modèle de règle d'approbation à un référentiel

L'associate-approval-rule-template-with-repositoryexemple suivant associe le modèle de règle d'approbation spécifié à un référentiel nomméMyDemoRepo.

aws codecommit associate-approval-rule-template-with-repository \
    --repository-name MyDemoRepo  \
    --approval-rule-template-name 2-approver-rule-for-main

Cette commande ne produit aucun résultat.

Pour plus d'informations, voir Associer un modèle de règle d'approbation à un référentiel dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserbatch-associate-approval-rule-template-with-repositories.

AWS CLI

Pour associer un modèle de règle d'approbation à plusieurs référentiels en une seule opération

L'batch-associate-approval-rule-template-with-repositoriesexemple suivant associe le modèle de règle d'approbation spécifié à des référentiels nommés MyDemoRepo etMyOtherDemoRepo.

Remarque : Les modèles de règles d'approbation sont spécifiques à la AWS région dans laquelle ils sont créés. Ils ne peuvent être associés qu'aux référentiels de cette AWS région.

aws codecommit batch-associate-approval-rule-template-with-repositories \
    --repository-names MyDemoRepo, MyOtherDemoRepo  \
    --approval-rule-template-name 2-approver-rule-for-main

Sortie :

{
    "associatedRepositoryNames": [
        "MyDemoRepo",
        "MyOtherDemoRepo"
    ],
    "errors": []
}

Pour plus d'informations, voir Associer un modèle de règle d'approbation à un référentiel dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserbatch-describe-merge-conflicts.

AWS CLI

Pour obtenir des informations sur les conflits de fusion dans tous les fichiers ou dans un sous-ensemble de fichiers lors d'une fusion entre deux spécificateurs de validation

L'batch-describe-merge-conflictsexemple suivant détermine les conflits de fusion liés à la fusion d'une branche source nommée feature-randomizationfeature avec une branche de destination nommée main selon la THREE_WAY_MERGE stratégie dans un référentiel nomméMyDemoRepo.

aws codecommit batch-describe-merge-conflicts \
    --source-commit-specifier feature-randomizationfeature \
    --destination-commit-specifier main \
    --merge-option THREE_WAY_MERGE \
    --repository-name MyDemoRepo

Sortie :

{
    "conflicts": [
        {
            "conflictMetadata": {
                "filePath": "readme.md",
                "fileSizes": {
                    "source": 139,
                    "destination": 230,
                    "base": 85
                },
                "fileModes": {
                    "source": "NORMAL",
                    "destination": "NORMAL",
                    "base": "NORMAL"
                },
                "objectTypes": {
                    "source": "FILE",
                    "destination": "FILE",
                    "base": "FILE"
                },
                "numberOfConflicts": 1,
                "isBinaryFile": {
                    "source": false,
                    "destination": false,
                    "base": false
                },
                "contentConflict": true,
                "fileModeConflict": false,
                "objectTypeConflict": false,
                "mergeOperations": {
                    "source": "M",
                    "destination": "M"
                }
            },
            "mergeHunks": [
                {
                    "isConflict": true,
                    "source": {
                        "startLine": 0,
                        "endLine": 3,
                        "hunkContent": "VGhpcyBpEXAMPLE=="
                    },
                    "destination": {
                        "startLine": 0,
                        "endLine": 1,
                        "hunkContent": "VXNlIHRoEXAMPLE="
                    }
                }
            ]
        }
    ],
    "errors": [],
    "destinationCommitId": "86958e0aEXAMPLE",
    "sourceCommitId": "6ccd57fdEXAMPLE",
    "baseCommitId": "767b6958EXAMPLE"
}

Pour plus d'informations, consultez la section Résoudre les conflits liés à une pull request dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserbatch-disassociate-approval-rule-template-from-repositories.

AWS CLI

Pour dissocier un modèle de règle d'approbation de plusieurs référentiels en une seule opération

L'batch-disassociate-approval-rule-template-from-repositoriesexemple suivant dissocie le modèle de règle d'approbation spécifié des référentiels nommés MyDemoRepo et. MyOtherDemoRepo

aws codecommit batch-disassociate-approval-rule-template-from-repositories \
    --repository-names MyDemoRepo, MyOtherDemoRepo  \
    --approval-rule-template-name 1-approval-rule-for-all pull requests

Sortie :

{
    "disassociatedRepositoryNames": [
        "MyDemoRepo",
        "MyOtherDemoRepo"
    ],
    "errors": []
}

Pour plus d'informations, voir Dissocier un modèle de règle d'approbation dans le guide de l'AWS CodeCommit utilisateur.

L'exemple de code suivant montre comment utiliserbatch-get-commits.

AWS CLI

Pour afficher les informations relatives à plusieurs validations

L'batch-get-commitsexemple suivant affiche des détails sur les validations spécifiées.

aws codecommit batch-get-commits  \
    --repository-name MyDemoRepo  \
    --commit-ids 317f8570EXAMPLE 4c925148EXAMPLE

Sortie :

{
    "commits": [
      {
        "additionalData": "",
        "committer": {
            "date": "1508280564 -0800",
            "name": "Mary Major",
            "email": "mary_major@example.com"
        },
        "author": {
            "date": "1508280564 -0800",
            "name": "Mary Major",
            "email": "mary_major@example.com"
        },
        "commitId": "317f8570EXAMPLE",
        "treeId": "1f330709EXAMPLE",
        "parents": [
            "6e147360EXAMPLE"
        ],
        "message": "Change variable name and add new response element"
    },
    {
        "additionalData": "",
        "committer": {
            "date": "1508280542 -0800",
            "name": "Li Juan",
            "email": "li_juan@example.com"
        },
        "author": {
            "date": "1508280542 -0800",
            "name": "Li Juan",
            "email": "li_juan@example.com"
        },
        "commitId": "4c925148EXAMPLE",
        "treeId": "1f330709EXAMPLE",
        "parents": [
            "317f8570EXAMPLE"
        ],
        "message": "Added new class"
    }
}

Pour plus d'informations, voir Afficher les détails des validations dans le guide de AWS CodeCommit l'utilisateur.

  • Pour API plus de détails, voir BatchGetCommitsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserbatch-get-repositories.

AWS CLI

Pour afficher les informations relatives à plusieurs référentiels

Cet exemple montre des détails sur plusieurs AWS CodeCommit référentiels.

aws codecommit batch-get-repositories \
    --repository-names MyDemoRepo MyOtherDemoRepo

Sortie :

{
    "repositoriesNotFound": [],
    "repositories": [
         {
            "creationDate": 1429203623.625,
            "defaultBranch": "main",
            "repositoryName": "MyDemoRepo",
            "cloneUrlSsh": "ssh://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo",
            "lastModifiedDate": 1430783812.0869999,
            "repositoryDescription": "My demonstration repository",
            "cloneUrlHttp": "https://codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo",
            "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE",
            "Arn": "arn:aws:codecommit:us-east-2:111111111111:MyDemoRepo"
            "accountId": "111111111111"
        },
        {
            "creationDate": 1429203623.627,
            "defaultBranch": "main",
            "repositoryName": "MyOtherDemoRepo",
            "cloneUrlSsh": "ssh://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyOtherDemoRepo",
            "lastModifiedDate": 1430783812.0889999,
            "repositoryDescription": "My other demonstration repository",
            "cloneUrlHttp": "https://codecommit.us-east-2.amazonaws.com/v1/repos/MyOtherDemoRepo",
            "repositoryId": "cfc29ac4-b0cb-44dc-9990-f6f51EXAMPLE",
            "Arn": "arn:aws:codecommit:us-east-2:111111111111:MyOtherDemoRepo"
            "accountId": "111111111111"
        }
    ],
    "repositoriesNotFound": []
}

L'exemple de code suivant montre comment utilisercreate-approval-rule-template.

AWS CLI

Pour créer un modèle de règle d'approbation

L'create-approval-rule-templateexemple suivant crée un modèle de règle d'approbation nommé 2-approver-rule-for-main ``. The template requires two users who assume the role of ``CodeCommitReview pour approuver toute pull request avant qu'elle ne puisse être fusionnée avec la main branche.

aws codecommit create-approval-rule-template \
    --approval-rule-template-name 2-approver-rule-for-main \
    --approval-rule-template-description  "Requires two developers from the team to approve the pull request if the destination branch is main" \
    --approval-rule-template-content "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}"

Sortie :

{
    "approvalRuleTemplate": {
        "approvalRuleTemplateName": "2-approver-rule-for-main",
        "creationDate": 1571356106.936,
        "approvalRuleTemplateId": "dd8b17fe-EXAMPLE",
        "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
        "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
        "approvalRuleTemplateDescription": "Requires two developers from the team to approve the pull request if the destination branch is main",
        "lastModifiedDate": 1571356106.936,
        "ruleContentSha256": "4711b576EXAMPLE"
    }
}

Pour plus d'informations, voir Création d'un modèle de règle d'approbation dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utilisercreate-branch.

AWS CLI

Pour créer une branche

Cet exemple crée une branche dans un AWS CodeCommit référentiel. Cette commande génère une sortie uniquement en cas d'erreurs.

Commande :

aws codecommit create-branch --repository-name MyDemoRepo --branch-name MyNewBranch --commit-id 317f8570EXAMPLE

Sortie :

None.

  • Pour API plus de détails, voir CreateBranchla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-commit.

AWS CLI

Pour créer un commit

L'create-commitexemple suivant montre comment créer un commit initial pour un dépôt qui ajoute un readme.md fichier à un dépôt nommé MyDemoRepo dans la main branche.

aws codecommit create-commit \
    --repository-name MyDemoRepo \
    --branch-name main \
    --put-files "filePath=readme.md,fileContent='Welcome to our team repository.'"

Sortie :

{
    "filesAdded": [
        {
            "blobId": "5e1c309d-EXAMPLE",
            "absolutePath": "readme.md",
            "fileMode": "NORMAL"
        }
    ],
    "commitId": "4df8b524-EXAMPLE",
    "treeId": "55b57003-EXAMPLE",
    "filesDeleted": [],
    "filesUpdated": []
}

Pour plus d'informations, consultez la section Créer un commit AWS CodeCommit dans le guide de AWS CodeCommit l'utilisateur.

  • Pour API plus de détails, voir CreateCommitla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-pull-request-approval-rule.

AWS CLI

Pour créer une règle d'approbation pour une pull request

L'create-pull-request-approval-ruleexemple suivant crée une règle d'approbation nommée Require two approved approvers pour la pull request spécifiée. La règle précise que deux approbations sont requises à partir d'un pool d'approbations. Le pool inclut tous les utilisateurs qui accèdent CodeCommit en assumant le rôle de CodeCommitReview dans le 123456789012 AWS compte. Il inclut également un IAM utilisateur ou un utilisateur fédéré nommé Nikhil_Jayashankar à partir du même AWS compte.

aws codecommit create-pull-request-approval-rule  \
    --approval-rule-name "Require two approved approvers"  \
    --approval-rule-content "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"CodeCommitApprovers:123456789012:Nikhil_Jayashankar\", \"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}"

Sortie :

{
    "approvalRule": {
        "approvalRuleName": "Require two approved approvers",
        "lastModifiedDate": 1570752871.932,
        "ruleContentSha256": "7c44e6ebEXAMPLE",
        "creationDate": 1570752871.932,
        "approvalRuleId": "aac33506-EXAMPLE",
        "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"CodeCommitApprovers:123456789012:Nikhil_Jayashankar\", \"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
        "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major"
    }
}

Pour plus d'informations, voir Création d'une règle d'approbation dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utilisercreate-pull-request.

AWS CLI

Pour créer une pull request

L'create-pull-requestexemple suivant crée une pull request nommée « Analyseur de difficulté de prononciation » avec la description « Veuillez revoir ces modifications d'ici mardi » qui cible la branche source « jane-branch » et doit être fusionnée avec la branche par défaut « main » dans un référentiel nommé « ». AWS CodeCommit MyDemoRepo

aws codecommit create-pull-request \
    --title "My Pull Request" \
    --description "Please review these changes by Tuesday" \
    --client-request-token 123Example \
    --targets repositoryName=MyDemoRepo,sourceReference=MyNewBranch

Sortie :

{
    "pullRequest": {
        "approvalRules": [
            {
                "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
                "approvalRuleId": "dd8b17fe-EXAMPLE",
                "approvalRuleName": "2-approver-rule-for-main",
                "creationDate": 1571356106.936,
                "lastModifiedDate": 571356106.936,
                "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
                "originApprovalRuleTemplate": {
                    "approvalRuleTemplateId": "dd3d22fe-EXAMPLE",
                    "approvalRuleTemplateName": "2-approver-rule-for-main"
                },
                "ruleContentSha256": "4711b576EXAMPLE"
            }
        ],
        "authorArn": "arn:aws:iam::111111111111:user/Jane_Doe",
        "description": "Please review these changes by Tuesday",
        "title": "Pronunciation difficulty analyzer",
        "pullRequestTargets": [
            {
                "destinationCommit": "5d036259EXAMPLE",
                "destinationReference": "refs/heads/main",
                "repositoryName": "MyDemoRepo",
                "sourceCommit": "317f8570EXAMPLE",
                "sourceReference": "refs/heads/jane-branch",
                "mergeMetadata": {
                    "isMerged": false
                }
            }
        ],
        "lastActivityDate": 1508962823.285,
        "pullRequestId": "42",
        "clientRequestToken": "123Example",
        "pullRequestStatus": "OPEN",
        "creationDate": 1508962823.285
    }
}

  • Pour API plus de détails, voir CreatePullRequestla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-repository.

AWS CLI

Pour créer un référentiel

Cet exemple crée un référentiel et l'associe au AWS compte de l'utilisateur.

Commande :

aws codecommit create-repository --repository-name MyDemoRepo --repository-description "My demonstration repository"

Sortie :

{
    "repositoryMetadata": {
        "repositoryName": "MyDemoRepo",
                "cloneUrlSsh": "ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo",
                "lastModifiedDate": 1444766838.027,
        "repositoryDescription": "My demonstration repository",
                "cloneUrlHttp": "https://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo",
        "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE",
                "Arn": "arn:aws:codecommit:us-east-1:111111111111EXAMPLE:MyDemoRepo",
        "accountId": "111111111111"
    }
}

  • Pour API plus de détails, voir CreateRepositoryla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-unreferenced-merge-commit.

AWS CLI

Pour créer un commit non référencé qui représente le résultat de la fusion de deux spécificateurs de commit

L'create-unreferenced-merge-commitexemple suivant crée un commit qui représente les résultats d'une fusion entre une branche source nommée et une branche bugfix-1234 de destination nommée à main l'aide de la MERGE stratégie THREE WAY _ _ dans un référentiel nomméMyDemoRepo.

aws codecommit create-unreferenced-merge-commit \
    --source-commit-specifier bugfix-1234 \
    --destination-commit-specifier main \
    --merge-option THREE_WAY_MERGE \
    --repository-name MyDemoRepo \
    --name "Maria Garcia" \
    --email "maria_garcia@example.com" \
    --commit-message "Testing the results of this merge."

Sortie :

{
    "commitId": "4f178133EXAMPLE",
    "treeId": "389765daEXAMPLE"
}

Pour plus d'informations, consultez la section Résoudre les conflits liés à une pull request dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utilisercredential-helper.

AWS CLI

Pour configurer l'assistant d'identification inclus dans le AWS CLI AWS CodeCommit

L'credential-helperutilitaire n'est pas conçu pour être appelé directement depuis le AWS CLI. Il est plutôt destiné à être utilisé comme paramètre avec la git config commande de configuration de votre ordinateur local. Il permet à Git d'utiliser HTTPS une version signée cryptographiquement de vos informations d'identification IAM utilisateur ou de votre rôle d'EC2instance Amazon chaque fois que Git a besoin de s'authentifier AWS pour interagir avec CodeCommit des référentiels.

git config --global credential.helper '!aws codecommit credential-helper $@'
git config --global credential.UseHttpPath true

Sortie :

[credential]
    helper = !aws codecommit credential-helper $@
    UseHttpPath = true

Pour plus d'informations, consultez la section Configuration pour AWS CodeCommit l'utilisation d'autres méthodes dans le guide de AWS CodeCommit l'utilisateur. Lisez attentivement le contenu, puis suivez les procédures décrites dans l'une des rubriques suivantes : Pour les HTTPS connexions sous Linux, macOS ou Unix ou Pour les HTTPS connexions sous Windows dans le guide de l'AWS CodeCommit utilisateur.

  • Pour API plus de détails, voir CredentialHelperla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-approval-rule-template.

AWS CLI

Pour supprimer un modèle de règle d'approbation

L'delete-approval-rule-templateexemple suivant supprime le modèle de règle d'approbation spécifié.

aws codecommit delete-approval-rule-template  \
    --approval-rule-template-name 1-approver-for-all-pull-requests

Sortie :

{
    "approvalRuleTemplateId": "41de97b7-EXAMPLE"
}

Pour plus d'informations, voir Supprimer un modèle de règle d'approbation dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserdelete-branch.

AWS CLI

Pour supprimer une branche

Cet exemple montre comment supprimer une branche dans un AWS CodeCommit référentiel.

Commande :

aws codecommit delete-branch --repository-name MyDemoRepo --branch-name MyNewBranch

Sortie :

{
  "branch": {
      "commitId": "317f8570EXAMPLE",
      "branchName": "MyNewBranch"
  }
}

  • Pour API plus de détails, voir DeleteBranchla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-comment-content.

AWS CLI

Pour supprimer le contenu d'un commentaire

Vous ne pouvez supprimer le contenu d'un commentaire que si vous l'avez créé. Cet exemple montre comment supprimer le contenu d'un commentaire dont l'ID généré par le système est de. ff30b348EXAMPLEb9aa670f

aws codecommit delete-comment-content \
    --comment-id ff30b348EXAMPLEb9aa670f

Sortie :

{
    "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
        }
    }
}

L'exemple de code suivant montre comment utiliserdelete-file.

AWS CLI

Pour supprimer un fichier

L'delete-fileexemple suivant montre comment supprimer un fichier nommé à README.md partir d'une branche main dont le nom de validation est le plus récent c5709475EXAMPLE dans un référentiel nomméMyDemoRepo.

aws codecommit delete-file \
    --repository-name MyDemoRepo \
    --branch-name main \
    --file-path README.md \
    --parent-commit-id c5709475EXAMPLE

Sortie :

{
    "blobId":"559b44fEXAMPLE",
    "commitId":"353cf655EXAMPLE",
    "filePath":"README.md",
    "treeId":"6bc824cEXAMPLE"
}

Pour plus d'informations, voir Modifier ou supprimer un fichier AWS CodeCommit dans le guide AWS CodeCommit APIde référence.

  • Pour API plus de détails, voir DeleteFilela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-pull-request-approval-rule.

AWS CLI

Pour supprimer une règle d'approbation pour une pull request

L'delete-pull-request-approval-ruleexemple suivant supprime la règle d'approbation nommée My Approval Rule pour la pull request spécifiée.

aws codecommit delete-pull-request-approval-rule  \
    --approval-rule-name "My Approval Rule"  \
    --pull-request-id 15

Sortie :

{
    "approvalRuleId": "077d8e8a8-EXAMPLE"
}

Pour plus d'informations, voir Modifier ou supprimer une règle d'approbation dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserdelete-repository.

AWS CLI

Pour supprimer un référentiel

Cet exemple montre comment supprimer un AWS CodeCommit dépôt.

Commande :

aws codecommit delete-repository --repository-name MyDemoRepo

Sortie :

{
  "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE"
}

  • Pour API plus de détails, voir DeleteRepositoryla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-merge-conflicts.

AWS CLI

Pour obtenir des informations détaillées sur les conflits de fusion

L'describe-merge-conflictsexemple suivant détermine les conflits de fusion pour un fichier nommé readme.md dans la branche source et la branche de destination spécifiées à l'aide de la MERGE stratégie THREE WAY _ _.

aws codecommit describe-merge-conflicts \
    --source-commit-specifier feature-randomizationfeature \
    --destination-commit-specifier main \
    --merge-option THREE_WAY_MERGE \
    --file-path readme.md \
    --repository-name MyDemoRepo

Sortie :

{
    "conflictMetadata": {
        "filePath": "readme.md",
        "fileSizes": {
            "source": 139,
            "destination": 230,
            "base": 85
        },
        "fileModes": {
            "source": "NORMAL",
            "destination": "NORMAL",
            "base": "NORMAL"
        },
        "objectTypes": {
            "source": "FILE",
            "destination": "FILE",
            "base": "FILE"
        },
        "numberOfConflicts": 1,
        "isBinaryFile": {
            "source": false,
            "destination": false,
            "base": false
        },
        "contentConflict": true,
        "fileModeConflict": false,
        "objectTypeConflict": false,
        "mergeOperations": {
            "source": "M",
            "destination": "M"
        }
    },
    "mergeHunks": [
        {
            "isConflict": true,
            "source": {
                "startLine": 0,
                "endLine": 3,
                "hunkContent": "VGhpcyBpEXAMPLE="
            },
            "destination": {
                "startLine": 0,
                "endLine": 1,
                "hunkContent": "VXNlIHRoEXAMPLE="
            }
        }
    ],
    "destinationCommitId": "86958e0aEXAMPLE",
    "sourceCommitId": "6ccd57fdEXAMPLE",
    "baseCommitId": "767b69580EXAMPLE"
}

Pour plus d'informations, consultez la section Résoudre les conflits liés à une pull request dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserdescribe-pull-request-events.

AWS CLI

Pour afficher les événements dans une pull request

L'describe-pull-request-eventsexemple suivant récupère les événements d'une pull request avec l'ID « 8 ».

aws codecommit describe-pull-request-events --pull-request-id 8

Sortie :

{
    "pullRequestEvents": [
        {
            "pullRequestId": "8",
            "pullRequestEventType": "PULL_REQUEST_CREATED",
            "eventDate": 1510341779.53,
            "actor": "arn:aws:iam::111111111111:user/Zhang_Wei"
        },
        {
            "pullRequestStatusChangedEventMetadata": {
                "pullRequestStatus": "CLOSED"
            },
            "pullRequestId": "8",
            "pullRequestEventType": "PULL_REQUEST_STATUS_CHANGED",
            "eventDate": 1510341930.72,
            "actor": "arn:aws:iam::111111111111:user/Jane_Doe"
        }
    ]
}

L'exemple de code suivant montre comment utiliserdisassociate-approval-rule-template-from-repository.

AWS CLI

Pour dissocier un modèle de règle d'approbation d'un référentiel

L'disassociate-approval-rule-template-from-repositoryexemple suivant dissocie le modèle de règle d'approbation spécifié d'un référentiel nomméMyDemoRepo.

aws codecommit disassociate-approval-rule-template-from-repository \
    --repository-name MyDemoRepo  \
    --approval-rule-template-name 1-approver-rule-for-all-pull-requests

Cette commande ne produit aucun résultat.

Pour plus d'informations, voir Dissocier un modèle de règle d'approbation dans le guide de l'AWS CodeCommit utilisateur.

L'exemple de code suivant montre comment utiliserevaluate-pull-request-approval-rules.

AWS CLI

Pour évaluer si toutes les règles d'approbation d'une pull request sont satisfaites

L'evaluate-pull-request-approval-rulesexemple suivant évalue l'état des règles d'approbation de la pull request spécifiée. Dans cet exemple, une règle d'approbation n'ayant pas été respectée pour la pull request, la sortie de la commande affiche une approved valeur defalse.

aws codecommit evaluate-pull-request-approval-rules \
    --pull-request-id 27  \
    --revision-id 9f29d167EXAMPLE

Sortie :

{
    "evaluation": {
        "approved": false,
        "approvalRulesNotSatisfied": [
            "Require two approved approvers"
        ],
        "overridden": false,
        "approvalRulesSatisfied": []
    }
}

Pour plus d'informations, consultez la section Fusionner une pull request dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserget-approval-rule-template.

AWS CLI

Pour obtenir le contenu d'un modèle de règle d'approbation

L'get-approval-rule-templateexemple suivant obtient le contenu d'un modèle de règle d'approbation nommé1-approver-rule-for-all-pull-requests.

aws codecommit get-approval-rule-template \
    --approval-rule-template-name 1-approver-rule-for-all-pull-requests

Sortie :

{
    "approvalRuleTemplate": {
        "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
        "ruleContentSha256": "621181bbEXAMPLE",
        "lastModifiedDate": 1571356106.936,
        "creationDate": 1571356106.936,
        "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests",
        "lastModifiedUser": "arn:aws:iam::123456789012:user/Li_Juan",
        "approvalRuleTemplateId": "a29abb15-EXAMPLE",
        "approvalRuleTemplateDescription": "All pull requests must be approved by one developer on the team."
    }
}

Pour plus d'informations, consultez la section Gérer les modèles de règles d'approbation dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserget-blob.

AWS CLI

Pour afficher les informations relatives à un objet blob Git

L'get-blobexemple suivant récupère des informations sur un blob Git portant l'ID « 2eb4af3b EXAMPLE » dans un dépôt nommé « ». AWS CodeCommit MyDemoRepo

aws codecommit get-blob  --repository-name MyDemoRepo  --blob-id 2eb4af3bEXAMPLE

Sortie :

{
    "content": "QSBCaW5hcnkgTGFyToEXAMPLE="
}

  • Pour API plus de détails, voir GetBlobla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-branch.

AWS CLI

Pour obtenir des informations sur une succursale

Cet exemple permet d'obtenir des informations sur une branche d'un AWS CodeCommit référentiel.

Commande :

aws codecommit get-branch --repository-name MyDemoRepo --branch-name MyNewBranch

Sortie :

{
  "BranchInfo": {
        "commitID": "317f8570EXAMPLE",
                "branchName": "MyNewBranch"
  }
}

  • Pour API plus de détails, voir GetBranchla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-comment-reactions.

AWS CLI

Pour afficher les réactions des emoji à un commentaire

L'get-comment-reactionsexemple suivant répertorie toutes les réactions emoji à un commentaire portant l'ID deabcd1234EXAMPLEb5678efgh. Si la police de votre shell prend en charge l'affichage de la version Emoji 1.0, la sortie de emoji l'emoji s'affiche.

aws codecommit get-comment-reactions \
    --comment-id abcd1234EXAMPLEb5678efgh

Sortie :

{
    "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"
                ]
            }
        ]
    }
}

Pour plus d'informations, consultez la section Commenter un commit AWS CodeCommit dans le guide de AWS CodeCommit l'utilisateur.

  • Pour API plus de détails, voir GetCommentReactionsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-comment.

AWS CLI

Pour afficher les détails d'un commentaire

Cet exemple montre comment afficher les détails d'un commentaire dont l'ID de commentaire généré par le système est de. ff30b348EXAMPLEb9aa670f

aws codecommit get-comment \
    --comment-id ff30b348EXAMPLEb9aa670f

Sortie :

{
    "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
        }
    }
}

  • Pour API plus de détails, voir GetCommentla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-comments-for-compared-commit.

AWS CLI

Pour consulter les commentaires relatifs à un commit

Cet exemple montre comment afficher les commentaires relatifs à la comparaison entre deux validations dans un référentiel nomméMyDemoRepo.

aws codecommit get-comments-for-compared-commit \
    --repository-name MyDemoRepo \
    --before-commit-ID 6e147360EXAMPLE \
    --after-commit-id 317f8570EXAMPLE

Sortie :

{
    "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"
}

L'exemple de code suivant montre comment utiliserget-comments-for-pull-request.

AWS CLI

Pour consulter les commentaires relatifs à une pull request

Cet exemple montre comment afficher les commentaires d'une pull request dans un référentiel nomméMyDemoRepo.

aws codecommit get-comments-for-pull-request \
    --repository-name MyDemoRepo \
    --before-commit-ID 317f8570EXAMPLE \
    --after-commit-id 5d036259EXAMPLE

Sortie :

{
    "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"
}

L'exemple de code suivant montre comment utiliserget-commit.

AWS CLI

Pour afficher les informations relatives à un commit dans un référentiel

Cet exemple montre les détails d'un commit dont l'identifiant généré par le système est « 7e9fd3091thisisanexamplethisisanexample1 » dans un référentiel nommé « ». AWS CodeCommit MyDemoRepo

Commande :

aws codecommit get-commit --repository-name MyDemoRepo --commit-id 7e9fd3091thisisanexamplethisisanexample1

Sortie :

{
  "commit": {
      "additionalData": "",
      "committer": {
          "date": "1484167798 -0800",
          "name": "Mary Major",
          "email": "mary_major@example.com"
      },
      "author": {
          "date": "1484167798 -0800",
          "name": "Mary Major",
          "email": "mary_major@example.com"
      },
      "treeId": "347a3408thisisanexampletreeidexample",
      "parents": [
          "7aa87a031thisisanexamplethisisanexample1"
      ],
      "message": "Fix incorrect variable name"
  }
}

  • Pour API plus de détails, voir GetCommitla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-differences.

AWS CLI

Pour obtenir des informations sur les différences entre un spécificateur de validation dans un référentiel

Cet exemple montre les informations de métadonnées d'affichage concernant les modifications entre deux spécificateurs de validation (brancheHEAD, balise ou autres références complètes, telles que commitIDs) dans un dossier renommé AWS CodeCommit du référentiel nommé MyDemoRepo. L'exemple inclut plusieurs options qui ne sont pas obligatoires, notamment --before-commit-specifier, --before-path et --after-path, afin d'illustrer de manière plus complète comment vous pouvez utiliser ces options pour limiter les résultats. La réponse inclut les autorisations relatives au mode fichier.

Commande :

aws codecommit get-differences --repository-name MyDemoRepo --before-commit-specifier 955bba12thisisanexamplethisisanexample --after-commit-specifier 14a95463thisisanexamplethisisanexample --before-path tmp/example-folder --after-path tmp/renamed-folder

Sortie :

{
  "differences": [
      {
          "afterBlob": {
              "path": "blob.txt",
              "blobId": "2eb4af3b1thisisanexamplethisisanexample1",
              "mode": "100644"
          },
          "changeType": "M",
          "beforeBlob": {
              "path": "blob.txt",
              "blobId": "bf7fcf281thisisanexamplethisisanexample1",
              "mode": "100644"
          }
      }
  ]
}

  • Pour API plus de détails, voir GetDifferencesla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-file.

AWS CLI

Pour obtenir le contenu codé en base 64 d'un fichier dans un dépôt AWS CodeCommit

L'get-fileexemple suivant montre comment obtenir le contenu codé en base 64 d'un fichier nommé README.md à partir d'une branche nommée main dans un référentiel nommé. MyDemoRepo

aws codecommit get-file \
    --repository-name MyDemoRepo \
    --commit-specifier main \
    --file-path README.md

Sortie :

{
    "blobId":"559b44fEXAMPLE",
    "commitId":"c5709475EXAMPLE",
    "fileContent":"IyBQaHVzEXAMPLE",
    "filePath":"README.md",
    "fileMode":"NORMAL",
    "fileSize":1563
}

Pour plus d'informations, consultez GetFilele guide AWS CodeCommit APIde référence.

  • Pour API plus de détails, voir GetFilela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-folder.

AWS CLI

Pour obtenir le contenu d'un dossier dans un AWS CodeCommit référentiel

L'get-folderexemple suivant montre comment obtenir le contenu d'un dossier de premier niveau à partir d'un référentiel nomméMyDemoRepo.

aws codecommit get-folder --repository-name MyDemoRepo --folder-path ""

Sortie :

{
    "commitId":"c5709475EXAMPLE",
    "files":[
        {
            "absolutePath":".gitignore",
            "blobId":"74094e8bEXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":".gitignore"
        },
        {
            "absolutePath":"Gemfile",
            "blobId":"9ceb72f6EXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":"Gemfile"
        },
        {
            "absolutePath":"Gemfile.lock",
            "blobId":"795c4a2aEXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":"Gemfile.lock"
        },
        {
            "absolutePath":"LICENSE.txt",
            "blobId":"0c7932c8EXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":"LICENSE.txt"
        },
        {
            "absolutePath":"README.md",
            "blobId":"559b44feEXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":"README.md"
        }
    ],
    "folderPath":"",
    "subFolders":[
        {
            "absolutePath":"public",
            "relativePath":"public",
            "treeId":"d5e92ae3aEXAMPLE"
        },
        {
            "absolutePath":"tmp",
            "relativePath":"tmp",
            "treeId":"d564d0bcEXAMPLE"
        }
    ],
    "subModules":[],
    "symbolicLinks":[],
    "treeId":"7b3c4dadEXAMPLE"
}

Pour plus d'informations, consultez GetFolder le guide AWS CodeCommit APIde référence.

  • Pour API plus de détails, voir GetFolderla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-merge-commit.

AWS CLI

Pour obtenir des informations détaillées sur un commit de fusion

L'get-merge-commitexemple suivant affiche les détails d'un commit de fusion pour la branche source nommée bugfix-bug1234 avec une branche de destination nommée à main l'aide de la MERGE stratégie THREE WAY _ _ dans un référentiel nomméMyDemoRepo.

aws codecommit get-merge-commit \
    --source-commit-specifier bugfix-bug1234 \
    --destination-commit-specifier main \
    --merge-option THREE_WAY_MERGE \
    --repository-name MyDemoRepo

Sortie :

{
    "sourceCommitId": "c5709475EXAMPLE",
    "destinationCommitId": "317f8570EXAMPLE",
    "baseCommitId": "fb12a539EXAMPLE",
    "mergeCommitId": "ffc4d608eEXAMPLE"
}

Pour plus d'informations, voir Afficher les détails des validations dans le guide de AWS CodeCommit l'utilisateur.

  • Pour API plus de détails, voir GetMergeCommitla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-merge-conflicts.

AWS CLI

Pour voir s'il existe des conflits de fusion pour une pull request

L'get-merge-conflictsexemple suivant indique s'il existe des conflits de fusion entre l'extrémité d'une branche source nommée feature-randomizationfeature et une branche de destination nommée « main » dans un référentiel nomméMyDemoRepo.

aws codecommit get-merge-conflicts \
    --repository-name MyDemoRepo \
    --source-commit-specifier feature-randomizationfeature \
    --destination-commit-specifier main \
    --merge-option THREE_WAY_MERGE

Sortie :

{
    "mergeable": false,
    "destinationCommitId": "86958e0aEXAMPLE",
    "sourceCommitId": "6ccd57fdEXAMPLE",
    "baseCommitId": "767b6958EXAMPLE",
    "conflictMetadataList": [
        {
            "filePath": "readme.md",
            "fileSizes": {
                "source": 139,
                "destination": 230,
                "base": 85
            },
            "fileModes": {
                "source": "NORMAL",
                "destination": "NORMAL",
                "base": "NORMAL"
            },
            "objectTypes": {
                "source": "FILE",
                "destination": "FILE",
                "base": "FILE"
            },
            "numberOfConflicts": 1,
            "isBinaryFile": {
                "source": false,
                "destination": false,
                "base": false
            },
            "contentConflict": true,
            "fileModeConflict": false,
            "objectTypeConflict": false,
            "mergeOperations": {
                "source": "M",
                "destination": "M"
            }
        }
    ]
}

  • Pour API plus de détails, voir GetMergeConflictsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-merge-options.

AWS CLI

Pour obtenir des informations sur les options de fusion disponibles pour fusionner deux branches spécifiées

L'get-merge-optionsexemple suivant détermine les options de fusion disponibles pour fusionner une branche source nommée bugfix-bug1234 avec une branche de destination nommée main dans un référentiel nomméMyDemoRepo.

aws codecommit get-merge-options \
    --source-commit-specifier bugfix-bug1234 \
    --destination-commit-specifier main \
    --repository-name MyDemoRepo

Sortie :

{
    "mergeOptions": [
        "FAST_FORWARD_MERGE",
        "SQUASH_MERGE",
        "THREE_WAY_MERGE"
    ],
    "sourceCommitId": "18059494EXAMPLE",
    "destinationCommitId": "ffd3311dEXAMPLE",
    "baseCommitId": "ffd3311dEXAMPLE"
}

Pour plus d'informations, consultez la section Résoudre les conflits liés à une pull request dans le guide de AWS CodeCommit l'utilisateur.

  • Pour API plus de détails, voir GetMergeOptionsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-pull-request-approval-states.

AWS CLI

Pour consulter les approbations sur une pull request

L'get-pull-request-approval-statesexemple suivant renvoie les approbations pour la pull request spécifiée.

aws codecommit get-pull-request-approval-states \
    --pull-request-id 8 \
    --revision-id 9f29d167EXAMPLE

Sortie :

{
    "approvals": [
        {
            "userArn": "arn:aws:iam::123456789012:user/Mary_Major",
            "approvalState": "APPROVE"
        }
    ]
}

Pour plus d'informations, consultez la section Afficher les pull requests dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserget-pull-request-override-state.

AWS CLI

Pour obtenir des informations sur le statut de dérogation d'une pull request

L'get-pull-request-override-stateexemple suivant renvoie l'état de remplacement pour la pull request spécifiée. Dans cet exemple, les règles d'approbation de la pull request ont été annulées par une utilisatrice nommée Mary Major, de sorte que la sortie renvoie une valeur de. true :

aws codecommit get-pull-request-override-state \
    --pull-request-id 34  \
    --revision-id 9f29d167EXAMPLE

Sortie :

{
    "overridden": true,
    "overrider": "arn:aws:iam::123456789012:user/Mary_Major"
}

Pour plus d'informations, consultez la section Remplacer les règles d'approbation relatives à une pull request dans le guide de l'AWS CodeCommit utilisateur.

L'exemple de code suivant montre comment utiliserget-pull-request.

AWS CLI

Pour afficher les détails d'une pull request

Cet exemple montre comment afficher les informations relatives à une pull request avec l'ID de27.

aws codecommit get-pull-request \
    --pull-request-id 27

Sortie :

{
    "pullRequest": {
        "approvalRules": [
            {
                "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
                "approvalRuleId": "dd8b17fe-EXAMPLE",
                "approvalRuleName": "2-approver-rule-for-main",
                "creationDate": 1571356106.936,
                "lastModifiedDate": 571356106.936,
                "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
                "ruleContentSha256": "4711b576EXAMPLE"
            }
        ],
        "lastActivityDate": 1562619583.565,
        "pullRequestTargets": [
            {
                "sourceCommit": "ca45e279EXAMPLE",
                "sourceReference": "refs/heads/bugfix-1234",
                "mergeBase": "a99f5ddbEXAMPLE",
                "destinationReference": "refs/heads/main",
                "mergeMetadata": {
                    "isMerged": false
                },
                "destinationCommit": "2abfc6beEXAMPLE",
                "repositoryName": "MyDemoRepo"
            }
        ],
        "revisionId": "e47def21EXAMPLE",
        "title": "Quick fix for bug 1234",
        "authorArn": "arn:aws:iam::123456789012:user/Nikhil_Jayashankar",
        "clientRequestToken": "d8d7612e-EXAMPLE",
        "creationDate": 1562619583.565,
        "pullRequestId": "27",
        "pullRequestStatus": "OPEN"
    }
}

  • Pour API plus de détails, voir GetPullRequestla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-repository-triggers.

AWS CLI

Pour obtenir des informations sur les déclencheurs dans un référentiel

Cet exemple montre des détails sur les déclencheurs configurés pour un AWS CodeCommit référentiel nomméMyDemoRepo.

aws codecommit get-repository-triggers \
    --repository-name MyDemoRepo

Sortie :

{
    "configurationId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE",
    "triggers": [
        {
            "destinationArn": "arn:aws:sns:us-east-1:111111111111:MyCodeCommitTopic",
            "branches": [
                "main",
                "preprod"
            ],
            "name": "MyFirstTrigger",
            "customData": "",
            "events": [
                "all"
            ]
        },
        {
            "destinationArn": "arn:aws:lambda:us-east-1:111111111111:function:MyCodeCommitPythonFunction",
            "branches": [],
            "name": "MySecondTrigger",
            "customData": "EXAMPLE",
            "events": [
                "all"
            ]
        }
    ]
}

L'exemple de code suivant montre comment utiliserget-repository.

AWS CLI

Pour obtenir des informations sur un référentiel

Cet exemple montre les détails d'un AWS CodeCommit dépôt.

aws codecommit get-repository \
    --repository-name MyDemoRepo

Sortie :

{
    "repositoryMetadata": {
        "creationDate": 1429203623.625,
        "defaultBranch": "main",
        "repositoryName": "MyDemoRepo",
        "cloneUrlSsh": "ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/v1/repos/MyDemoRepo",
        "lastModifiedDate": 1430783812.0869999,
        "repositoryDescription": "My demonstration repository",
        "cloneUrlHttp": "https://codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo",
        "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE",
        "Arn": "arn:aws:codecommit:us-east-1:80398EXAMPLE:MyDemoRepo
        "accountId": "111111111111"
    }
}

  • Pour API plus de détails, voir GetRepositoryla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-approval-rule-templates.

AWS CLI

Pour répertorier tous les modèles de règles d'approbation d'une AWS région

L'list-approval-rule-templatesexemple suivant répertorie tous les modèles de règles d'approbation dans la région spécifiée. Si aucune AWS région n'est spécifiée en tant que paramètre, la commande renvoie des modèles de règles d'approbation pour la région spécifiée dans le AWS CLI profil utilisé pour exécuter la commande.

aws codecommit list-approval-rule-templates \
    --region us-east-2

Sortie :

{
    "approvalRuleTemplateNames": [
        "2-approver-rule-for-main",
        "1-approver-rule-for-all-pull-requests"
    ]
}

Pour plus d'informations, consultez la section Gérer les modèles de règles d'approbation dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserlist-associated-approval-rule-templates-for-repository.

AWS CLI

Pour répertorier tous les modèles associés à un référentiel

L'list-associated-approval-rule-templates-for-repositoryexemple suivant répertorie tous les modèles de règles d'approbation associés à un référentiel nomméMyDemoRepo.

aws codecommit list-associated-approval-rule-templates-for-repository \
    --repository-name MyDemoRepo

Sortie :

{
  "approvalRuleTemplateNames": [
    "2-approver-rule-for-main",
    "1-approver-rule-for-all-pull-requests"
  ]
}

Pour plus d'informations, consultez la section Gérer les modèles de règles d'approbation dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserlist-branches.

AWS CLI

Pour consulter la liste des noms de succursales

Cet exemple répertorie tous les noms de branches d'un AWS CodeCommit référentiel.

aws codecommit list-branches \
    --repository-name MyDemoRepo

Sortie :

{
    "branches": [
        "MyNewBranch",
        "main"
    ]
}

  • Pour API plus de détails, voir ListBranchesla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-pull-requests.

AWS CLI

Pour afficher la liste des pull requests dans un référentiel

Cet exemple montre comment répertorier les pull requests créées par un IAM utilisateur avec le code ARN « arn:aws:iam : :111111111111:user/LI_JUAN » et le statut « » dans un référentiel nommé « » : CLOSED AWS CodeCommit MyDemoRepo

aws codecommit list-pull-requests --author-arn arn:aws:iam::111111111111:user/Li_Juan --pull-request-status CLOSED --repository-name MyDemoRepo

Sortie :

{
 "nextToken": "",
 "pullRequestIds": ["2","12","16","22","23","35","30","39","47"]
}

  • Pour API plus de détails, voir ListPullRequestsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-repositories-for-approval-rule-template.

AWS CLI

Pour répertorier tous les référentiels associés à un modèle

L'list-repositories-for-approval-rule-templateexemple suivant répertorie tous les référentiels associés au modèle de règle d'approbation spécifié.

aws codecommit list-repositories-for-approval-rule-template \
    --approval-rule-template-name 2-approver-rule-for-main

Sortie :

{
    "repositoryNames": [
        "MyDemoRepo",
        "MyClonedRepo"
    ]
}

Pour plus d'informations, consultez la section Gérer les modèles de règles d'approbation dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserlist-repositories.

AWS CLI

Pour afficher la liste des référentiels

Cet exemple répertorie tous les AWS CodeCommit référentiels associés au AWS compte de l'utilisateur.

Commande :

aws codecommit list-repositories

Sortie :

{
  "repositories": [
      {
         "repositoryName": "MyDemoRepo"
         "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE",
      },
      {
         "repositoryName": "MyOtherDemoRepo"
         "repositoryId": "cfc29ac4-b0cb-44dc-9990-f6f51EXAMPLE"
      }
  ]
}

  • Pour API plus de détails, voir ListRepositoriesla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-tags-for-resource.

AWS CLI

Pour afficher les AWS balises d'un référentiel

L'list-tags-for-resourceexemple suivant répertorie les clés de balise et les valeurs de balise pour le référentiel spécifié.

aws codecommit list-tags-for-resource \
    --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo

Sortie :

{
    "tags": {
        "Status": "Secret",
        "Team": "Saanvi"
    }
}

Pour plus d'informations, voir Afficher les balises d'un référentiel dans le guide de AWS CodeCommit l'utilisateur.

  • Pour API plus de détails, voir ListTagsForResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisermerge-branches-by-fast-forward.

AWS CLI

Pour fusionner deux succursales à l'aide de la stratégie de fusion accélérée

L'merge-branches-by-fast-forwardexemple suivant fusionne la branche source spécifiée avec la branche de destination spécifiée dans un référentiel nomméMyDemoRepo.

aws codecommit merge-branches-by-fast-forward \
    --source-commit-specifier bugfix-bug1234 \
    --destination-commit-specifier bugfix-bug1233 \
    --repository-name MyDemoRepo

Sortie :

{
    "commitId": "4f178133EXAMPLE",
    "treeId": "389765daEXAMPLE"
}

Pour plus d'informations, consultez la section Comparer et fusionner des branches dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utilisermerge-branches-by-squash.

AWS CLI

Pour fusionner deux branches à l'aide de la stratégie de fusion Squash

L'merge-branches-by-squashexemple suivant fusionne la branche source spécifiée avec la branche de destination spécifiée dans un référentiel nomméMyDemoRepo.

aws codecommit merge-branches-by-squash \
    --source-commit-specifier bugfix-bug1234 \
    --destination-commit-specifier bugfix-bug1233 \
    --author-name "Maria Garcia" \
    --email "maria_garcia@example.com" \
    --commit-message "Merging two fix branches to prepare for a general patch." \
    --repository-name MyDemoRepo

Sortie :

{
    "commitId": "4f178133EXAMPLE",
    "treeId": "389765daEXAMPLE"
}

Pour plus d'informations, consultez la section Comparer et fusionner des branches dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utilisermerge-branches-by-three-way.

AWS CLI

Pour fusionner deux succursales à l'aide de la stratégie de fusion à trois voies

L'merge-branches-by-three-wayexemple suivant fusionne la branche source spécifiée avec la branche de destination spécifiée dans un référentiel nomméMyDemoRepo.

aws codecommit merge-branches-by-three-way \
    --source-commit-specifier main \
    --destination-commit-specifier bugfix-bug1234 \
    --author-name "Jorge Souza" --email "jorge_souza@example.com" \
    --commit-message "Merging changes from main to bugfix branch before additional testing." \
    --repository-name MyDemoRepo

Sortie :

{
    "commitId": "4f178133EXAMPLE",
    "treeId": "389765daEXAMPLE"
}

Pour plus d'informations, consultez la section Comparer et fusionner des branches dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utilisermerge-pull-request-by-fast-forward.

AWS CLI

Pour fusionner et fermer une pull request

Cet exemple montre comment fusionner et fermer une pull request ayant l'ID « 47 » et l'ID de validation source « 99132ab0 EXAMPLE » dans un référentiel nommé. MyDemoRepo

aws codecommit merge-pull-request-by-fast-forward \
    --pull-request-id 47 \
    --source-commit-id 99132ab0EXAMPLE \
    --repository-name MyDemoRepo

Sortie :

{
    "pullRequest": {
        "approvalRules": [
            {
                "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
                "approvalRuleId": "dd8b17fe-EXAMPLE",
                "approvalRuleName": "I want one approver for this pull request",
                "creationDate": 1571356106.936,
                "lastModifiedDate": 571356106.936,
                "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
                "ruleContentSha256": "4711b576EXAMPLE"
            }
        ],
        "authorArn": "arn:aws:iam::123456789012:user/Li_Juan",
        "clientRequestToken": "",
        "creationDate": 1508530823.142,
        "description": "Review the latest changes and updates to the global variables",
        "lastActivityDate": 1508887223.155,
        "pullRequestId": "47",
        "pullRequestStatus": "CLOSED",
        "pullRequestTargets": [
            {
                "destinationCommit": "9f31c968EXAMPLE",
                "destinationReference": "refs/heads/main",
                "mergeMetadata": {
                    "isMerged": true,
                    "mergedBy": "arn:aws:iam::123456789012:user/Mary_Major"
                },
                "repositoryName": "MyDemoRepo",
                "sourceCommit": "99132ab0EXAMPLE",
                "sourceReference": "refs/heads/variables-branch"
            }
        ],
        "title": "Consolidation of global variables"
    }
}

Pour plus d'informations, consultez la section Fusionner une pull request dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utilisermerge-pull-request-by-squash.

AWS CLI

Pour fusionner une pull request à l'aide de la stratégie de fusion Squash

L'merge-pull-request-by-squashexemple suivant fusionne et ferme la pull request spécifiée en utilisant la stratégie de résolution des conflits de ACCEPT _ SOURCE dans un référentiel nomméMyDemoRepo.

aws codecommit merge-pull-request-by-squash \
    --pull-request-id 47 \
    --source-commit-id 99132ab0EXAMPLE \
    --repository-name MyDemoRepo \
    --conflict-detail-level LINE_LEVEL \
    --conflict-resolution-strategy ACCEPT_SOURCE \
    --name "Jorge Souza" --email "jorge_souza@example.com" \
    --commit-message "Merging pull request 47 by squash and accepting source in merge conflicts"

Sortie :

{
    "pullRequest": {
        "approvalRules": [
            {
                "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
                "approvalRuleId": "dd8b17fe-EXAMPLE",
                "approvalRuleName": "2-approver-rule-for-main",
                "creationDate": 1571356106.936,
                "lastModifiedDate": 571356106.936,
                "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
                "originApprovalRuleTemplate": {
                    "approvalRuleTemplateId": "dd8b17fe-EXAMPLE",
                    "approvalRuleTemplateName": "2-approver-rule-for-main"
                },
                "ruleContentSha256": "4711b576EXAMPLE"
            }
        ],
        "authorArn": "arn:aws:iam::123456789012:user/Li_Juan",
        "clientRequestToken": "",
        "creationDate": 1508530823.142,
        "description": "Review the latest changes and updates to the global variables",
        "lastActivityDate": 1508887223.155,
        "pullRequestId": "47",
        "pullRequestStatus": "CLOSED",
        "pullRequestTargets": [
            {
                "destinationCommit": "9f31c968EXAMPLE",
                "destinationReference": "refs/heads/main",
                "mergeMetadata": {
                    "isMerged": true,
                    "mergedBy": "arn:aws:iam::123456789012:user/Mary_Major"
                },
                "repositoryName": "MyDemoRepo",
                "sourceCommit": "99132ab0EXAMPLE",
                "sourceReference": "refs/heads/variables-branch"
            }
        ],
        "title": "Consolidation of global variables"
    }
}

Pour plus d'informations, consultez la section Fusionner une pull request dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utilisermerge-pull-request-by-three-way.

AWS CLI

Pour fusionner une pull request à l'aide de la stratégie de fusion à trois voies

L'merge-pull-request-by-three-wayexemple suivant fusionne et ferme la pull request spécifiée à l'aide des options par défaut relatives au détail des conflits et à la stratégie de résolution des conflits dans un référentiel nomméMyDemoRepo.

aws codecommit merge-pull-request-by-three-way \
    --pull-request-id 47 \
    --source-commit-id 99132ab0EXAMPLE \
    --repository-name MyDemoRepo \
    --name "Maria Garcia" \
    --email "maria_garcia@example.com" \
    --commit-message "Merging pull request 47 by three-way with default options"

Sortie :

{
    "pullRequest": {
        "approvalRules": [
            {
                "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
                "approvalRuleId": "dd8b17fe-EXAMPLE",
                "approvalRuleName": "2-approver-rule-for-main",
                "creationDate": 1571356106.936,
                "lastModifiedDate": 571356106.936,
                "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
                "originApprovalRuleTemplate": {
                    "approvalRuleTemplateId": "dd8b17fe-EXAMPLE",
                    "approvalRuleTemplateName": "2-approver-rule-for-main"
                },
                "ruleContentSha256": "4711b576EXAMPLE"
            }
        ],
        "authorArn": "arn:aws:iam::123456789012:user/Li_Juan",
        "clientRequestToken": "",
        "creationDate": 1508530823.142,
        "description": "Review the latest changes and updates to the global variables",
        "lastActivityDate": 1508887223.155,
        "pullRequestId": "47",
        "pullRequestStatus": "CLOSED",
        "pullRequestTargets": [
            {
                "destinationCommit": "9f31c968EXAMPLE",
                "destinationReference": "refs/heads/main",
                "mergeMetadata": {
                    "isMerged": true,
                    "mergedBy": "arn:aws:iam::123456789012:user/Mary_Major"
                },
                "repositoryName": "MyDemoRepo",
                "sourceCommit": "99132ab0EXAMPLE",
                "sourceReference": "refs/heads/variables-branch"
            }
        ],
        "title": "Consolidation of global variables"
    }
}

Pour plus d'informations, consultez la section Fusionner une pull request dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliseroverride-pull-request-approval-rules.

AWS CLI

Pour contourner les exigences des règles d'approbation relatives à une pull request

L'override-pull-request-approval-rulesexemple suivant remplace les règles d'approbation relatives à la pull request spécifiée. Pour annuler une dérogation à la place, définissez la valeur du --override-status paramètre sur. REVOKE

aws codecommit override-pull-request-approval-rules \
    --pull-request-id 34  \
    --revision-id 927df8d8EXAMPLE \
    --override-status OVERRIDE

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Remplacer les règles d'approbation relatives à une pull request dans le guide de l'AWS CodeCommit utilisateur.

L'exemple de code suivant montre comment utiliserpost-comment-for-compared-commit.

AWS CLI

Pour créer un commentaire sur un commit

Cet exemple montre comment ajouter le commentaire "Can you add a test case for this?" sur la modification apportée au cl_sample.js fichier lors de la comparaison entre deux validations dans un référentiel nommé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

Sortie :

{
    "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"
    }
}

L'exemple de code suivant montre comment utiliserpost-comment-for-pull-request.

AWS CLI

Pour ajouter un commentaire à une pull request

L'post-comment-for-pull-requestexemple suivant ajoute le commentaire « Ils ne semblent être utilisés nulle part. Can we remove them? » sur la modification du ahs_count.py fichier dans une pull request avec l'ID de 47 dans un dépôt nommé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

Sortie :

{
     "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,
            "CommentId": "",
            "lastModifiedDate": 1508369622.123,
            "callerReactions": [],
            "reactionCounts": []
        },
        "location": {
            "filePath": "ahs_count.py",
            "filePosition": 367,
            "relativeFileVersion": "AFTER"
         },
     "repositoryName": "MyDemoRepo",
     "pullRequestId": "47"
}

L'exemple de code suivant montre comment utiliserpost-comment-reply.

AWS CLI

Pour répondre à un commentaire sur un commit ou dans une pull request

Cet exemple montre comment ajouter la réponse "Good catch. I'll remove them." au commentaire avec l'ID généré par le système de. abcd1234EXAMPLEb5678efgh

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

Sortie :

{
    "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": []
    }
}

  • Pour API plus de détails, voir PostCommentReplyla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-comment-reaction.

AWS CLI

Pour répondre à un commentaire sur un commit avec un emoji

L'put-comment-reactionexemple suivant répond à un commentaire avec l'ID de abcd1234EXAMPLEb5678efgh avec une valeur de réaction emoji de:thumbsup:.

aws codecommit put-comment-reaction \
    --comment-id abcd1234EXAMPLEb5678efgh \
    --reaction-value :thumbsup:

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Commenter un commit AWS CodeCommit dans le guide de AWS CodeCommit l'utilisateur.

  • Pour API plus de détails, voir PutCommentReactionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-file.

AWS CLI

Pour ajouter un fichier à un référentiel

L'put-fileexemple suivant ajoute un fichier nommé « ExampleSolution .py » à un référentiel nommé « » dans une branche nommée « MyDemoRepo feature-randomizationfeature » dont le dernier commit porte l'ID « 4c925148 ». EXAMPLE

aws codecommit put-file \
    --repository-name MyDemoRepo \
    --branch-name feature-randomizationfeature \
    --file-content file://MyDirectory/ExampleSolution.py \
    --file-path /solutions/ExampleSolution.py \
    --parent-commit-id 4c925148EXAMPLE \
    --name "Maria Garcia" \
    --email "maria_garcia@example.com" \
    --commit-message "I added a third randomization routine."

Sortie :

{
    "blobId": "2eb4af3bEXAMPLE",
    "commitId": "317f8570EXAMPLE",
    "treeId": "347a3408EXAMPLE"
}

  • Pour API plus de détails, voir PutFilela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-repository-triggers.

AWS CLI

Pour ajouter ou mettre à jour un déclencheur dans un référentiel

Cet exemple montre comment mettre à jour les déclencheurs nommés MyFirstTrigger « » et « MySecondTrigger » à l'aide d'un JSON fichier déjà créé (ici nommé MyTriggers .json) qui contient la structure de tous les déclencheurs d'un référentiel nommé. MyDemoRepo Pour savoir comment obtenir JSON les déclencheurs existants, consultez la get-repository-triggers commande.

aws codecommit put-repository-triggers \
    --repository-name MyDemoRepo file://MyTriggers.json

Contenu de MyTriggers.json :

{
    "repositoryName": "MyDemoRepo",
    "triggers": [
        {
            "destinationArn": "arn:aws:sns:us-east-1:80398EXAMPLE:MyCodeCommitTopic",
            "branches": [
                "main",
                "preprod"
            ],
            "name": "MyFirstTrigger",
            "customData": "",
            "events": [
                "all"
            ]
        },
        {
            "destinationArn": "arn:aws:lambda:us-east-1:111111111111:function:MyCodeCommitPythonFunction",
            "branches": [],
            "name": "MySecondTrigger",
            "customData": "EXAMPLE",
            "events": [
                "all"
            ]
        }
    ]
}

Sortie :

{
    "configurationId": "6fa51cd8-35c1-EXAMPLE"
}

L'exemple de code suivant montre comment utilisertag-resource.

AWS CLI

Pour ajouter des AWS balises à un référentiel existant

L'tag-resourceexemple suivant balise le référentiel spécifié avec deux balises.

aws codecommit tag-resource \
    --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo \
    --tags Status=Secret,Team=Saanvi

Cette commande ne produit aucun résultat.

Pour plus d'informations, voir Ajouter une balise à un référentiel dans le guide de AWS CodeCommit l'utilisateur.

  • Pour API plus de détails, voir TagResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisertest-repository-triggers.

AWS CLI

Pour tester les déclencheurs dans un référentiel

Cet exemple montre comment tester un déclencheur nommé « MyFirstTrigger » dans un AWS CodeCommit référentiel nommé MyDemoRepo. Dans cet exemple, les événements du référentiel déclenchent des notifications provenant d'une rubrique Amazon Simple Notification Service (AmazonSNS).

Commande :

aws codecommit test-repository-triggers --repository-name MyDemoRepo --triggers name=MyFirstTrigger,destinationArn=arn:aws:sns:us-east-1:111111111111:MyCodeCommitTopic,branches=mainline,preprod,events=all

Sortie :

{
  "successfulExecutions": [
      "MyFirstTrigger"
  ],
  "failedExecutions": []
}

L'exemple de code suivant montre comment utiliseruntag-resource.

AWS CLI

Pour supprimer des AWS balises d'un référentiel

L'untag-resourceexemple suivant supprime la balise avec la clé spécifiée du référentiel nomméMyDemoRepo.

aws codecommit untag-resource \
    --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo \
    --tag-keys Status

Cette commande ne produit aucun résultat.

Pour plus d'informations, voir Supprimer une étiquette d'un référentiel dans le guide de AWS CodeCommit l'utilisateur.

  • Pour API plus de détails, voir UntagResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-approval-rule-template-content.

AWS CLI

Pour mettre à jour le contenu d'un modèle de règle d'approbation

L'update-approval-rule-template-contentexemple suivant modifie le contenu du modèle de règle d'approbation spécifié afin de redéfinir le pool d'approbation pour les utilisateurs qui assument le rôle deCodeCommitReview.

aws codecommit update-approval-rule-template-content \
    --approval-rule-template-name 1-approver-rule  \
    --new-rule-content "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}"

Sortie :

{
    "approvalRuleTemplate": {
        "creationDate": 1571352720.773,
        "approvalRuleTemplateDescription": "Requires 1 approval for all pull requests from the CodeCommitReview pool",
        "lastModifiedDate": 1571358728.41,
        "approvalRuleTemplateId": "41de97b7-EXAMPLE",
        "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
        "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests",
        "ruleContentSha256": "2f6c21a5EXAMPLE",
        "lastModifiedUser": "arn:aws:iam::123456789012:user/Li_Juan"
    }
}

Pour plus d'informations, consultez la section Gérer les modèles de règles d'approbation dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserupdate-approval-rule-template-description.

AWS CLI

Pour mettre à jour la description d'un modèle de règle d'approbation

L'update-approval-rule-template-descriptionexemple suivant change la description du modèle de règle d'approbation spécifié enRequires 1 approval for all pull requests from the CodeCommitReview pool. :

aws codecommit update-approval-rule-template-description \
    --approval-rule-template-name 1-approver-rule-for-all-pull-requests  \
    --approval-rule-template-description "Requires 1 approval for all pull requests from the CodeCommitReview pool"

Sortie :

{
  "approvalRuleTemplate": {
    "creationDate": 1571352720.773,
    "approvalRuleTemplateDescription": "Requires 1 approval for all pull requests from the CodeCommitReview pool",
    "lastModifiedDate": 1571358728.41,
    "approvalRuleTemplateId": "41de97b7-EXAMPLE",
    "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
    "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests",
    "ruleContentSha256": "2f6c21a5EXAMPLE",
    "lastModifiedUser": "arn:aws:iam::123456789012:user/Li_Juan"
  }
}

Pour plus d'informations, consultez la section Gérer les modèles de règles d'approbation dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserupdate-approval-rule-template-name.

AWS CLI

Pour mettre à jour le nom d'un modèle de règle d'approbation

L'update-approval-rule-template-nameexemple suivant change le nom d'un modèle de règle d'approbation en 1- approver-rule-for-all -pull-requests`. 1-approver-rule

aws codecommit update-approval-rule-template-name \
    --old-approval-rule-template-name 1-approver-rule  \
    --new-approval-rule-template-name 1-approver-rule-for-all-pull-requests

Sortie :

{
  "approvalRuleTemplate": {
    "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests",
    "lastModifiedDate": 1571358241.619,
    "approvalRuleTemplateId": "41de97b7-EXAMPLE",
    "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
    "creationDate": 1571352720.773,
    "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
    "approvalRuleTemplateDescription": "All pull requests must be approved by one developer on the team.",
    "ruleContentSha256": "2f6c21a5cEXAMPLE"
  }
}

Pour plus d'informations, consultez la section Gérer les modèles de règles d'approbation dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserupdate-comment.

AWS CLI

Pour mettre à jour un commentaire sur un commit

Cet exemple montre comment ajouter du contenu "Fixed as requested. I'll update the pull request." à un commentaire dont l'ID est442b498bEXAMPLE5756813.

aws codecommit update-comment \
    --comment-id 442b498bEXAMPLE5756813 \
    --content "Fixed as requested. I'll update the pull request."

Sortie :

{
    "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
            }
    }
}

  • Pour API plus de détails, voir UpdateCommentla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-default-branch.

AWS CLI

Pour modifier la branche par défaut d'un référentiel

Cet exemple modifie la branche par défaut d'un AWS CodeCommit référentiel. Cette commande génère une sortie uniquement en cas d'erreurs.

Commande :

aws codecommit update-default-branch --repository-name MyDemoRepo --default-branch-name MyNewBranch

Sortie :

None.

  • Pour API plus de détails, voir UpdateDefaultBranchla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-pull-request-approval-rule-content.

AWS CLI

Pour modifier une règle d'approbation pour une pull request

L'update-pull-request-approval-rule-contentexemple suivant met à jour la règle d'approbation qu'elle a spécifiée pour exiger l'approbation d'un utilisateur à partir d'un pool d'approbation qui inclut n'importe quel IAM utilisateur du 123456789012 AWS compte.

aws codecommit update-pull-request-approval-rule-content \
    --pull-request-id 27  \
    --approval-rule-name "Require two approved approvers" \
    --approval-rule-content "{Version: 2018-11-08, Statements: [{Type: \"Approvers\", NumberOfApprovalsNeeded: 1, ApprovalPoolMembers:[\"CodeCommitApprovers:123456789012:user/*\"]}]}}"

Sortie :

{
    "approvalRule": {
        "approvalRuleContent": "{Version: 2018-11-08, Statements: [{Type: \"Approvers\", NumberOfApprovalsNeeded: 1, ApprovalPoolMembers:[\"CodeCommitApprovers:123456789012:user/*\"]}]}}",
        "approvalRuleId": "aac33506-EXAMPLE",
        "originApprovalRuleTemplate": {},
        "creationDate": 1570752871.932,
        "lastModifiedDate": 1570754058.333,
        "approvalRuleName": Require two approved approvers",
        "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
        "ruleContentSha256": "cd93921cEXAMPLE",
    }
}

Pour plus d'informations, voir Modifier ou supprimer une règle d'approbation dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserupdate-pull-request-approval-state.

AWS CLI

Pour approuver ou révoquer l'approbation d'une pull request

L'update-pull-request-approval-stateexemple suivant approuve une pull request avec l'ID 27 et l'ID de révision de9f29d167EXAMPLE. Si vous souhaitez plutôt révoquer l'approbation, définissez la valeur du --approval-state paramètre surREVOKE.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Révision d'une pull request dans le guide de AWS CodeCommit l'utilisateur.

L'exemple de code suivant montre comment utiliserupdate-pull-request-description.

AWS CLI

Pour modifier la description d'une pull request

Cet exemple montre comment modifier la description d'une pull request avec l'ID de47.

aws codecommit update-pull-request-description \
    --pull-request-id 47 \
    --description "Updated the pull request to remove unused global variable."

Sortie :

{
    "pullRequest": {
        "authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
        "clientRequestToken": "",
        "creationDate": 1508530823.155,
        "description": "Updated the pull request to remove unused global variable.",
        "lastActivityDate": 1508372423.204,
        "pullRequestId": "47",
        "pullRequestStatus": "OPEN",
        "pullRequestTargets": [
            {
                "destinationCommit": "9f31c968EXAMPLE",
                "destinationReference": "refs/heads/main",
                "mergeMetadata": {
                    "isMerged": false,
                },
                "repositoryName": "MyDemoRepo",
                "sourceCommit": "99132ab0EXAMPLE",
                "sourceReference": "refs/heads/variables-branch"
            }
        ],
        "title": "Consolidation of global variables"
    }
}

L'exemple de code suivant montre comment utiliserupdate-pull-request-status.

AWS CLI

Pour modifier le statut d'une pull request

Cet exemple montre comment modifier le statut d'une pull request avec l'ID de 42 en un statut de CLOSED dans un AWS CodeCommit référentiel nomméMyDemoRepo.

aws codecommit update-pull-request-status \
    --pull-request-id 42 \
    --pull-request-status CLOSED

Sortie :

{
    "pullRequest": {
        "approvalRules": [
            {
                "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
                "approvalRuleId": "dd8b17fe-EXAMPLE",
                "approvalRuleName": "2-approvers-needed-for-this-change",
                "creationDate": 1571356106.936,
                "lastModifiedDate": 571356106.936,
                "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
                "ruleContentSha256": "4711b576EXAMPLE"
            }
        ],
        "authorArn": "arn:aws:iam::123456789012:user/Li_Juan",
        "clientRequestToken": "",
        "creationDate": 1508530823.165,
        "description": "Updated the pull request to remove unused global variable.",
        "lastActivityDate": 1508372423.12,
        "pullRequestId": "47",
        "pullRequestStatus": "CLOSED",
        "pullRequestTargets": [
            {
                "destinationCommit": "9f31c968EXAMPLE",
                "destinationReference": "refs/heads/main",
                "mergeMetadata": {
                    "isMerged": false,
                },
                "repositoryName": "MyDemoRepo",
                "sourceCommit": "99132ab0EXAMPLE",
                "sourceReference": "refs/heads/variables-branch"
            }
        ],
        "title": "Consolidation of global variables"
    }
}

L'exemple de code suivant montre comment utiliserupdate-pull-request-title.

AWS CLI

Pour modifier le titre d'une pull request

Cet exemple montre comment modifier le titre d'une pull request avec l'ID de47.

aws codecommit update-pull-request-title \
    --pull-request-id 47 \
    --title "Consolidation of global variables - updated review"

Sortie :

{
    "pullRequest": {
        "approvalRules": [
            {
                "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
                "approvalRuleId": "dd8b17fe-EXAMPLE",
                "approvalRuleName": "2-approver-rule-for-main",
                "creationDate": 1571356106.936,
                "lastModifiedDate": 571356106.936,
                "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
                "originApprovalRuleTemplate": {
                    "approvalRuleTemplateId": "dd8b26gr-EXAMPLE",
                    "approvalRuleTemplateName": "2-approver-rule-for-main"
                },
                "ruleContentSha256": "4711b576EXAMPLE"
            }
        ],
        "authorArn": "arn:aws:iam::123456789012:user/Li_Juan",
        "clientRequestToken": "",
        "creationDate": 1508530823.12,
        "description": "Review the latest changes and updates to the global variables. I have updated this request with some changes, including removing some unused variables.",
        "lastActivityDate": 1508372657.188,
        "pullRequestId": "47",
        "pullRequestStatus": "OPEN",
        "pullRequestTargets": [
            {
                "destinationCommit": "9f31c968EXAMPLE",
                "destinationReference": "refs/heads/main",
                "mergeMetadata": {
                    "isMerged": false,
                },
                "repositoryName": "MyDemoRepo",
                "sourceCommit": "99132ab0EXAMPLE",
                "sourceReference": "refs/heads/variables-branch"
            }
        ],
        "title": "Consolidation of global variables - updated review"
    }
}

L'exemple de code suivant montre comment utiliserupdate-repository-description.

AWS CLI

Pour modifier la description d'un référentiel

Cet exemple modifie la description d'un AWS CodeCommit référentiel. Cette commande génère une sortie uniquement en cas d'erreurs.

Commande :

aws codecommit update-repository-description --repository-name MyDemoRepo --repository-description "This description was changed"

Sortie :

None.

L'exemple de code suivant montre comment utiliserupdate-repository-name.

AWS CLI

Pour modifier le nom d'un dépôt

Cet exemple modifie le nom d'un AWS CodeCommit dépôt. Cette commande génère une sortie uniquement en cas d'erreurs. La modification du nom du AWS CodeCommit référentiel modifiera le SSH et HTTPS URLs dont les utilisateurs ont besoin pour se connecter au référentiel. Les utilisateurs ne pourront pas se connecter à ce référentiel tant qu'ils n'auront pas mis à jour leurs paramètres de connexion. De plus, étant donné que le référentiel ARN va changer, la modification du nom du référentiel invalidera toutes les politiques IAM utilisateur qui s'appuient sur celui de ARN ce référentiel.

Commande :

aws codecommit update-repository-name --old-name MyDemoRepo --new-name MyRenamedDemoRepo

Sortie :

None.