View a markdown version of this page

CodeCommit référence de l'action source - AWS CodePipeline
Type d'actionParamètres de configurationArtefacts d'entréeArtefacts de sortieVariables de sortieAutorisations relatives aux rôles de service : CodeCommit actionExemple de configuration d'actionConsultez aussi

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 référence de l'action source

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 EventBridge règle qui démarre votre pipeline lorsqu'une modification se produit dans le référentiel.

Note

Pour Amazon ECR, Amazon S3 ou les CodeCommit sources, vous pouvez également créer un remplacement de source à l'aide d'une entrée de transformation en entrée EventBridge pour utiliser l'revisionValueentrée de votre événement de pipeline, où le revisionValue est dérivé de la variable d'événement source pour votre clé d'objet, votre commit ou votre ID d'image. Pour plus d'informations, consultez l'étape facultative pour la saisie de la transformation d'entrée incluse dans les procédures sous Actions et ressources relatives aux sources Amazon ECR EventBridgeConnexion aux actions de source Amazon S3 avec une source activée pour les événements, ouCodeCommit actions à la source et EventBridge.

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.

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

    Actuellement, la référence 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 transmettre une référence d'URL Git à des CodeBuild 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 CodePipeline les modifications apportées à la source sont interrogées dans le CodeCommit référentiel. Nous vous recommandons plutôt d'utiliser CloudWatch Events 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) (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 en double.

Valeurs valides pour ce paramètre :

  • true: si cette option est définie, CodePipeline interroge votre référentiel pour détecter les modifications apportées à la source.

    Note

    Si vous l'omettezPollForSourceChanges, la CodePipeline valeur par défaut est interrogée dans votre référentiel pour détecter les modifications apportées à la 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 n'interroge pas votre référentiel pour détecter les modifications apportées à la 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 soit, CODEBUILD_CLONE_REF soitCODE_ZIP. Si aucune valeur n'est spécifiée, la valeur par défaut est CODE_ZIP.

Important

L'option CODEBUILD_CLONE_REF 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 des CodeBuild GitClone autorisations pour les actions à CodeCommit la source. Vous devez également ajouter l'codecommit:GetRepositoryautorisation à votre rôle CodePipeline de service, comme indiqué dansAjouter des autorisations au rôle CodePipeline de service. Pour un didacticiel qui explique comment utiliser l'option de clonage complet, consultezTutoriel : 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 de plus amples informations, veuillez consulter Référence des 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

Le 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.

CommitterDate

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

Autorisations relatives aux rôles de service : CodeCommit action

Lors de l' CodePipeline exécution de l'action, la politique de rôle de CodePipeline service nécessite les autorisations suivantes, dont la portée est appropriée jusqu'à l'ARN de la ressource du pipeline afin de conserver l'accès avec le moins de privilèges possible. Par exemple, ajoutez ce qui suit à votre déclaration de politique :

JSON
{
    "Version":"2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "codecommit:CancelUploadArchive",
                "codecommit:GetBranch",
                "codecommit:GetCommit",
                "codecommit:GetRepository",
                "codecommit:GetUploadArchiveStatus",
                "codecommit:UploadArchive"
            ],
            "Resource": [
                "arn:aws:codecommit:*:111122223333:[[codecommitRepostories]]"
            ]
        }
    ]
}

Exemple de configuration d'action

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

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

Exemple de format d'artefact de sortie de clonage 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.