CodeStarSourceConnection pour Bitbucket Cloud GitHub, GitHub Enterprise Server et GitLab.com les actions GitLab autogérées

Les actions source pour les connexions sont prises en charge par AWS CodeConnections. CodeConnections vous permet de créer et de gérer des connexions entre AWS des ressources et des référentiels tiers tels que GitHub. Démarre un pipeline lorsqu'un nouveau commit est effectué sur un référentiel de code source tiers. L'action source récupère les modifications de code lorsqu'un pipeline est exécuté manuellement ou lorsqu'un événement webhook est envoyé par le fournisseur source.

Vous pouvez configurer les actions de votre pipeline pour utiliser une configuration Git qui vous permet de démarrer votre pipeline à l'aide de déclencheurs. Pour configurer la configuration des déclencheurs du pipeline afin de filtrer à l'aide de déclencheurs, voir plus de détails dansAjouter un déclencheur avec des types d'événements de type « code push » ou « pull request ».

Note

Cette fonctionnalité n'est pas disponible dans les régions Asie-Pacifique (Hong Kong), Asie-Pacifique (Hyderabad), Asie-Pacifique (Jakarta), Asie-Pacifique (Melbourne), Asie-Pacifique (Osaka), Afrique (Le Cap), Moyen-Orient (Bahreïn), Moyen-Orient (Émirats arabes unis), Europe (Espagne), Europe (Zurich), Israël (Tel Aviv) ou AWS GovCloud (US-West). Pour consulter les autres actions disponibles, consultezIntégrations de produits et de services avec CodePipeline. Pour les considérations relatives à cette action dans la région Europe (Milan), voir la note figurant dansCodeStarSourceConnection pour Bitbucket Cloud GitHub, GitHub Enterprise Server et GitLab.com les actions GitLab autogérées.

Connections peut associer vos AWS ressources aux référentiels tiers suivants :

• Bitbucket Cloud (via l'option du fournisseur Bitbucket dans la CodePipeline console ou le Bitbucket fournisseur dans la CLI)

  Note

  Vous pouvez créer des connexions à un référentiel Bitbucket Cloud. Les types de fournisseurs Bitbucket installés, tels que Bitbucket Server, ne sont pas pris en charge.

• Note

  Si vous utilisez un espace de travail Bitbucket, vous devez disposer d'un accès administrateur pour créer la connexion.

• GitHub et GitHub Enterprise Cloud (via l'option de fournisseur GitHub (via GitHub l'application) dans la CodePipeline console ou le GitHub fournisseur dans la CLI)

  Note

  Si votre référentiel se trouve dans une GitHub organisation, vous devez en être le propriétaire pour créer la connexion. Si vous utilisez un référentiel qui n'appartient pas à une organisation, vous devez en être le propriétaire.

• GitHub Enterprise Server (via l'option GitHub Enterprise Server provider dans la CodePipeline console ou via le GitHub Enterprise Server fournisseur dans la CLI)

• GitLab.com (via l'option du GitLab fournisseur dans la CodePipeline console ou le GitLab fournisseur dans la CLI)

  Note

  Vous pouvez créer des connexions à un référentiel dans lequel vous avez le rôle Propriétaire GitLab, puis la connexion peut être utilisée avec le référentiel contenant des ressources telles que CodePipeline. Pour les référentiels dans des groupes, il n'est pas nécessaire d'être le propriétaire du groupe.

• Self-managed installation pour GitLab (Enterprise Edition ou Community Edition) (via l'option de fournisseur GitLab autogéré dans la CodePipeline console ou le GitLabSelfManaged fournisseur dans la CLI)

Note

Chaque connexion prend en charge tous les référentiels que vous possédez auprès de ce fournisseur. Il vous suffit de créer une nouvelle connexion pour chaque type de fournisseur.

Les connexions permettent à votre pipeline de détecter les changements de source via l'application d'installation du fournisseur tiers. Par exemple, les webhooks sont utilisés pour s'abonner à des types d' GitHub événements et peuvent être installés sur une organisation, un référentiel ou une GitHub application. Votre connexion installe un webhook de référentiel sur votre GitHub application qui s'abonne à des événements de type GitHub push.

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 : comme les autres actions CodePipeline source existantes, elle CodeStarSourceConnection peut générer un fichier ZIP contenant une copie superficielle de votre commit.

• Clone complet : CodeStarSourceConnection peut également être configuré pour générer une référence URL vers le dépôt 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.

CodePipeline vous invite à ajouter l'application d'installation AWS Connector à votre compte tiers lorsque vous créez une connexion. Vous devez déjà avoir créé votre compte et votre référentiel de fournisseur tiers pour pouvoir vous connecter via cette CodeStarSourceConnection action.

Note

Pour créer ou associer une politique à votre rôle avec les autorisations requises pour utiliser les AWS CodeStar connexions, consultez la section Référence des autorisations de connexions. Selon la date de création CodePipeline de votre rôle de service, vous devrez peut-être mettre à jour ses autorisations pour prendre en charge AWS CodeStar les connexions. Pour obtenir des instructions, veuillez consulter Ajouter des autorisations au rôle CodePipeline de service.

Note

Pour utiliser les connexions en Europe (Milan) Région AWS, vous devez :

1. Installer une Region-specific application

2. Activer la région

Cette Region-specific application prend en charge les connexions dans la région Europe (Milan). Elle est publiée sur le site du fournisseur tiers et est distincte de l'application existante qui prend en charge les connexions pour d'autres régions. En installant cette application, vous autorisez les fournisseurs tiers à partager vos données avec le service pour cette région uniquement et vous pouvez révoquer les autorisations à tout moment en désinstallant l'application.

Le service ne traitera ni ne stockera vos données à moins que vous n'activiez la région. En activant cette région, vous autorisez notre service à traiter et à stocker vos données.

Même si la région n'est pas activée, les fournisseurs tiers peuvent toujours partager vos données avec notre service si l' Region-specific application reste installée. Veillez donc à désinstaller l'application une fois que vous avez désactivé la région. Pour plus d'informations, consultez Activer une région.

Type d'action

• Catégorie : Source

• Propriétaire : AWS

• Fournisseur : CodeStarSourceConnection

• Version : 1

Paramètres de configuration

ConnectionArn

Obligatoire : oui

ARN de connexion qui est configuré et authentifié pour le fournisseur de source.

FullRepositoryId

Obligatoire : oui

Propriétaire et nom du référentiel où les modifications de la source doivent être détectées.

Exemple : some-user/my-repo

Important

Vous devez conserver la bonne majuscule pour la FullRepositoryId valeur. Par exemple, si votre nom d'utilisateur est some-user et que le nom du dépôt estMy-Repo, la valeur recommandée FullRepositoryId estsome-user/My-Repo.

BranchName

Obligatoire : oui

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

OutputArtifactFormat

Obligatoire : non

Spécifie le format de l'artefact de sortie. Peut avoir la valeur CODEBUILD_CLONE_REF ou CODE_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 devrez mettre à jour les autorisations pour votre rôle de service de CodeBuild projet, comme indiqué dansAjoutez CodeBuild GitClone des autorisations pour les connexions à Bitbucket GitHub, GitHub Enterprise Server ou GitLab.com. Pour un didacticiel qui explique comment utiliser l'option de clonage complet, consultezTutoriel : Utiliser un clone complet avec une source de GitHub pipeline.

DetectChanges

Obligatoire : non

Contrôle le démarrage automatique de votre pipeline lorsqu'un nouveau commit est effectué sur le référentiel et la branche configurés. Si elle n'est pas spécifiée, la valeur par défaut est true et le champ ne s'affiche pas par défaut. Valeurs valides pour ce paramètre :

• true: démarre CodePipeline automatiquement votre pipeline sur les nouveaux commits.

• false: CodePipeline ne démarre pas votre pipeline lors des nouveaux commits.

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 : Les artefacts générés à partir du référentiel sont les artefacts de sortie de l'action CodeStarSourceConnection. 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. Vous pouvez configurer l'artefact de sortie de cette action dans :

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

  • Un fichier JSON qui contient une référence d'URL au référentiel afin que les actions en aval puissent exécuter directement les commandes Git.

    Important

    Cette option ne peut être utilisée que par des actions CodeBuild en aval.

    Si vous choisissez cette option, vous devrez mettre à jour les autorisations pour votre rôle de service de CodeBuild projet, comme indiqué dansRésolution des problèmes CodePipeline. Pour un didacticiel qui explique comment utiliser l'option de clonage complet, consultezTutoriel : Utiliser un clone complet avec une source de GitHub pipeline.

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.

AuthorDate

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

BranchName

Nom de la branche du référentiel où la modification de la source a été effectuée.

CommitId

ID de validation ayant déclenché l'exécution du pipeline.

CommitMessage

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

ConnectionArn

ARN de connexion qui est configuré et authentifié pour le fournisseur de source.

FullRepositoryName

Nom du référentiel où la validation ayant déclenché le pipeline a été effectuée.

Autorisations relatives aux rôles de service : CodeConnections action

Pour CodeConnections, l'autorisation suivante est requise pour créer des pipelines avec une source qui utilise une connexion, telle que Bitbucket Cloud.

{
    "Effect": "Allow",
    "Action": [
        "codeconnections:UseConnection",
        "codestar-connections:UseConnection"
    ],
    "Resource": "resource_ARN"
},

Note

Les deux actions sont requises. Opérations invoquées via un appelcodestar-connections:UseConnection, tandis que les opérations sont invoquées en dehors de l'appelcodeconnections:UseConnection. L'octroi des deux actions garantit que le rôle fonctionne pour les deux chemins de code, que l'ARN de la ressource de la connexion utilise codeconnections ou non le préfixe codestar-connections de service.

Pour plus d'informations sur les autorisations IAM pour les connexions, voir Référence https://docs.aws.amazon.com/dtconsole/latest/userguide/security-iam.html#permissions-reference-connections des autorisations de connexions.

Déclaration d'action

Dans l'exemple suivant, l'artefact de sortie est défini sur le format ZIP par défaut de CODE_ZIP pour la connexion avec ARNarn:aws:codestar-connections:region:account-id:connection/connection-id.

YAML

Name: Source
Actions:
  - InputArtifacts: []
    ActionTypeId:
      Version: '1'
      Owner: AWS
      Category: Source
      Provider: CodeStarSourceConnection
    OutputArtifacts:
      - Name: SourceArtifact
    RunOrder: 1
    Configuration:
      ConnectionArn: "arn:aws:codestar-connections:region:account-id:connection/connection-id"
      FullRepositoryId: "some-user/my-repo"
      BranchName: "main"
      OutputArtifactFormat: "CODE_ZIP"
    Name: ApplicationSource

JSON

{
    "Name": "Source",
    "Actions": [
        {
            "InputArtifacts": [],
            "ActionTypeId": {
                "Version": "1",
                "Owner": "AWS",
                "Category": "Source",
                "Provider": "CodeStarSourceConnection"
            },
            "OutputArtifacts": [
                {
                    "Name": "SourceArtifact"
                }
            ],
            "RunOrder": 1,
            "Configuration": {
                "ConnectionArn": "arn:aws:codestar-connections:region:account-id:connection/connection-id",
                "FullRepositoryId": "some-user/my-repo",
                "BranchName": "main",
                "OutputArtifactFormat": "CODE_ZIP"
            },
            "Name": "ApplicationSource"
        }
    ]
},

Installation de l'application d'installation et création d'une connexion

La première fois que vous utilisez la console pour ajouter une nouvelle connexion à un référentiel tiers, vous devez autoriser CodePipeline l'accès à vos référentiels. Vous choisissez ou créez une application d'installation qui vous aide à vous connecter au compte sur lequel vous avez créé votre référentiel de codes tiers.

Lorsque vous utilisez le AWS CLI ou un CloudFormation modèle, vous devez fournir l'ARN de connexion d'une connexion qui a déjà fait l'objet de la poignée de main d'installation. Sinon, le pipeline n'est pas déclenché.

Note

Pour une action CodeStarSourceConnection source, il n'est pas nécessaire de configurer un webhook ou d'effectuer un sondage par défaut. L'action Connections gère la détection de votre changement de source pour vous.

Consultez aussi

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

• AWS::CodeStarConnections: :Connection — La référence du CloudFormation modèle pour la ressource AWS CodeStar Connections fournit des paramètres et des exemples de connexions dans les CloudFormation modèles.

• AWS CodeStarRéférence de l'API AWS CodeStar Connections — La référence de l'API Connections fournit des informations de référence pour les actions de connexion disponibles.

• Pour consulter les étapes de création d'un pipeline dont les actions source sont prises en charge par les connexions, consultez les rubriques suivantes :

  • Pour Bitbucket Cloud, utilisez l'option Bitbucket dans la console ou l'CodestarSourceConnectionaction dans l'interface de ligne de commande. Consultez Connexions Bitbucket Cloud.

  • Pour GitHub et GitHub Enterprise Cloud, utilisez l'option GitHub provider dans la console ou l'CodestarSourceConnectionaction dans l'interface de ligne de commande. Consultez GitHub connexions.

  • Pour GitHub Enterprise Server, utilisez l'option GitHub Enterprise Server provider dans la console ou l'CodestarSourceConnectionaction dans l'interface de ligne de commande. Consultez GitHub Connexions aux serveurs d'entreprise.

  • Pour GitLab.com, utilisez l'option GitLab provider dans la console ou l'CodestarSourceConnectionaction avec le GitLab fournisseur dans la CLI. Consultez GitLab.com connexions.

• Pour consulter un didacticiel de démarrage qui crée un pipeline avec une source Bitbucket et une CodeBuild action, consultez la section Démarrage avec les connexions.

• Pour un didacticiel qui explique comment vous connecter à un GitHub référentiel et utiliser l'option de clonage complet avec une CodeBuild action en aval, consultezTutoriel : Utiliser un clone complet avec une source de GitHub pipeline.