CodeCommit - AWS CodePipeline

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

Démarre le pipeline lorsqu'un nouveau commit est effectué sur le CodeCommit référentiel et la branche configurés.

Si vous utilisez la console pour créer ou modifier le pipeline, CodePipeline crée une règle d' CodeCommit CloudWatch événements qui démarre votre pipeline lorsqu'une modification intervient dans le référentiel.

Vous devez déjà avoir créé un CodeCommit référentiel avant de connecter le pipeline par le biais d'une CodeCommit action.

Une fois qu'une modification de code est détectée, vous disposez des options suivantes pour transmettre le code aux actions suivantes :

  • Par défaut : configure l'action CodeCommit source pour générer un fichier ZIP contenant une copie superficielle de votre commit.

  • Clonage complet : configure l'action source pour générer une référence d'URL Git vers le référentiel pour les actions suivantes.

    Actuellement, la référence d'URL Git ne peut être utilisée que par des CodeBuild actions en aval pour cloner le dépôt et les métadonnées Git associées. Toute tentative de transmission d'une référence d'URL Git à CodeBuild des non-actions entraîne une erreur.

Type d'action

  • Catégorie : Source

  • Propriétaire : AWS

  • Fournisseur : CodeCommit

  • Version : 1

Paramètres de configuration

RepositoryName

Obligatoire : oui

Nom du référentiel où les modifications de la source doivent être détectées.

BranchName

Obligatoire : oui

Nom de la branche où les modifications de la source doivent être détectées.

PollForSourceChanges

Obligatoire : non

PollForSourceChangescontrôle si le CodePipeline CodeCommit référentiel est interrogé pour connaître les modifications de source. Nous vous recommandons plutôt d'utiliser CloudWatch les événements pour détecter les modifications de source. Pour plus d'informations sur la configuration CloudWatch des événements, consultez Migrer les pipelines de sondage (CodeCommit source) (CLI) ouMigrer les pipelines de sondage (CodeCommit source) (AWS CloudFormation modèle).

Important

Si vous avez l'intention de configurer une règle d' CloudWatch événements, vous devez la définir PollForSourceChanges pour false éviter les exécutions de pipeline dupliquées.

Valeurs valides pour ce paramètre :

  • true: si cette option est définie, CodePipeline interroge votre dépôt pour connaître les modifications de source.

    Note

    Si vous omettezPollForSourceChanges, CodePipeline par défaut, votre dépôt est interrogé pour vérifier les modifications de source. Ce comportement est le même que si PollForSourceChanges est inclus et défini sur true.

  • false: si cette option est définie, CodePipeline elle n'interroge pas votre dépôt pour connaître les modifications de source. Utilisez ce paramètre si vous avez l'intention de configurer une règle d' CloudWatch événements pour détecter les modifications de source.

OutputArtifactFormat

Obligatoire : non

Format d'artefact de sortie. Les valeurs peuvent être CODEBUILD_CLONE_REF soitCODE_ZIP. Si aucune valeur n'est spécifiée, la valeur par défaut est CODE_ZIP.

Important

L'CODEBUILD_CLONE_REFoption ne peut être utilisée que par des actions CodeBuild en aval.

Si vous choisissez cette option, vous devez ajouter l'codecommit:GitPullautorisation à votre rôle de CodeBuild service, comme indiqué dansAjouter CodeBuild GitClone des autorisations pour les actions CodeCommit source. Vous devez également ajouter l'codecommit:GetRepositoryautorisation à votre rôle CodePipeline de service, comme indiqué dansAjout d'autorisations au rôle de service CodePipeline. Pour consulter un didacticiel expliquant comment utiliser l'option de clonage complet, voirTutoriel : Utiliser un clone complet avec une source de CodeCommit pipeline.

Artefacts d'entrée

  • Nombre d'objets : 0

  • Description : Les artefacts d'entrée ne s'appliquent pas à ce type d'action.

Artefacts de sortie

  • Nombre d'objets : 1

  • Description : l'artefact de sortie de cette action est un fichier ZIP qui regroupe le contenu du référentiel et de la branche configurés au moment de la validation spécifiée comme révision source pour l'exécution du pipeline. Les artefacts générés à partir du référentiel sont les artefacts de sortie de l' CodeCommit action. L'ID de validation du code source est affiché en CodePipeline tant que révision source pour l'exécution du pipeline déclenchée.

Variables de sortie

Lorsque cette action est configurée, elle produit des variables qui peuvent être référencées par la configuration d'action d'une action en aval dans le pipeline. Cette action produit des variables qui peuvent être visualisées en tant que variables de sortie, même si l'action n'a pas d'espace de noms. Vous configurez une action avec un espace de noms pour rendre ces variables disponibles pour la configuration des actions en aval.

Pour plus d’informations, consultez Variables.

CommitId

L'ID de CodeCommit validation qui a déclenché l'exécution du pipeline. Les ID de validation sont le SHA complet de la validation.

CommitMessage

Message de description, le cas échéant, associé à la validation ayant déclenché l'exécution du pipeline.

RepositoryName

Nom du CodeCommit référentiel dans lequel le commit qui a déclenché le pipeline a été effectué.

BranchName

Nom de la branche du CodeCommit référentiel dans lequel la modification de source a été effectuée.

AuthorDate

Date à laquelle la validation a été créée, au format horodatage.

Pour plus d'informations sur la différence entre un auteur et un valideur dans Git, consultez les informations sur l'affichage de l'historique de validation dans Pro Git, de Scott Chacon et Ben Straub.

CommitterDate

Date à laquelle la validation a été validée, au format horodatage.

Pour plus d'informations sur la différence entre un auteur et un valideur dans Git, consultez les informations sur l'affichage de l'historique de validation dans Pro Git, de Scott Chacon et Ben Straub.

Exemple de configuration d'action

Exemple de format d'artefact de sortie par défaut

YAML
Actions: - OutputArtifacts: - Name: Artifact_MyWebsiteStack InputArtifacts: [] Name: source Configuration: RepositoryName: MyWebsite BranchName: main PollForSourceChanges: 'false' RunOrder: 1 ActionTypeId: Version: '1' Provider: CodeCommit Category: Source Owner: AWS Name: Source
JSON
{ "Actions": [ { "OutputArtifacts": [ { "Name": "Artifact_MyWebsiteStack" } ], "InputArtifacts": [], "Name": "source", "Configuration": { "RepositoryName": "MyWebsite", "BranchName": "main", "PollForSourceChanges": "false" }, "RunOrder": 1, "ActionTypeId": { "Version": "1", "Provider": "CodeCommit", "Category": "Source", "Owner": "AWS" } } ], "Name": "Source" },

Exemple de format d'artefact de sortie d'un clone complet

YAML
name: Source actionTypeId: category: Source owner: AWS provider: CodeCommit version: '1' runOrder: 1 configuration: BranchName: main OutputArtifactFormat: CODEBUILD_CLONE_REF PollForSourceChanges: 'false' RepositoryName: MyWebsite outputArtifacts: - name: SourceArtifact inputArtifacts: [] region: us-west-2 namespace: SourceVariables
JSON
{ "name": "Source", "actionTypeId": { "category": "Source", "owner": "AWS", "provider": "CodeCommit", "version": "1" }, "runOrder": 1, "configuration": { "BranchName": "main", "OutputArtifactFormat": "CODEBUILD_CLONE_REF", "PollForSourceChanges": "false", "RepositoryName": "MyWebsite" }, "outputArtifacts": [ { "name": "SourceArtifact" } ], "inputArtifacts": [], "region": "us-west-2", "namespace": "SourceVariables" }

Les ressources connexes suivantes peuvent s'avérer utiles dans le cadre de l'utilisation de cette action.

  • Tutoriel : Création d'un pipeline simple (CodeCommitréférentiel)— Ce didacticiel fournit un exemple de fichier de spécifications d'application, un exemple d' CodeDeploy application et un groupe de déploiement. Utilisez ce didacticiel pour créer un pipeline avec une CodeCommit source qui se déploie sur des instances Amazon EC2.