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.

Annexe A : actions relatives aux sources de la GitHub version 1

Cette annexe fournit des informations sur la version 1 de l' GitHub action dans CodePipeline.

Pour l'intégrer GitHub, CodePipeline utilise une GitHub OAuth application pour votre pipeline. CodePipelineutilise des webhooks pour gérer la détection des modifications pour votre pipeline avec l'action source de la GitHub version 1.

Cette référence contient les sections suivantes pour l'action de la GitHub version 1 :

Ajouter une action source de GitHub version 1

Vous ajoutez des actions source de GitHub version 1 CodePipeline en :

GitHub référence d'action source de la version 1

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

Pour l'intégrer GitHub, CodePipeline utilise une OAuth application ou un jeton d'accès personnel pour votre pipeline. Si vous utilisez la console pour créer ou modifier votre pipeline, CodePipeline crée un GitHub webhook qui démarre votre pipeline lorsqu'une modification intervient dans le référentiel.

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

Si vous souhaitez limiter l'accès aux CodePipeline référentiels, créez un GitHub compte et accordez au compte l'accès uniquement aux référentiels auxquels vous souhaitez vous intégrer. CodePipeline Utilisez ce compte lorsque vous configurez CodePipeline l'utilisation de GitHub référentiels pour les étapes source dans les pipelines.

Pour plus d'informations, consultez la documentation destinée aux GitHub développeurs sur le GitHub site Web.

Type d'action

Paramètres de configuration

Artefacts d'entrée

Artefacts de sortie

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 sur les variables dans CodePipeline, consultezRéférence aux variables.

Déclaration d'action (exemple GitHub)

YAML

Name: Source
Actions:
  - InputArtifacts: []
    ActionTypeId:
      Version: '1'
      Owner: ThirdParty
      Category: Source
      Provider: GitHub
    OutputArtifacts:
      - Name: SourceArtifact
    RunOrder: 1
    Configuration:
      Owner: MyGitHubAccountName
      Repo: MyGitHubRepositoryName
      PollForSourceChanges: 'false'
      Branch: main
      OAuthToken: '{{resolve:secretsmanager:MyGitHubSecret:SecretString:token}}'
    Name: ApplicationSource

JSON

{
    "Name": "Source",
    "Actions": [
        {
            "InputArtifacts": [],
            "ActionTypeId": {
                "Version": "1",
                "Owner": "ThirdParty",
                "Category": "Source",
                "Provider": "GitHub"
            },
            "OutputArtifacts": [
                {
                    "Name": "SourceArtifact"
                }
            ],
            "RunOrder": 1,
            "Configuration": {
                "Owner": "MyGitHubAccountName",
                "Repo": "MyGitHubRepositoryName",
                "PollForSourceChanges": "false",
                "Branch": "main",
                "OAuthToken": "{{resolve:secretsmanager:MyGitHubSecret:SecretString:token}}"
            },
            "Name": "ApplicationSource"
        }
    ]
},

Connexion à GitHub (OAuth)

La première fois que vous utilisez la console pour ajouter un GitHub dépôt à un pipeline, il vous est demandé d'autoriser CodePipeline l'accès à vos référentiels. Le jeton nécessite les GitHub étendues suivantes :

Lorsque vous utilisez le CLI ou un AWS CloudFormation modèle, vous devez fournir la valeur d'un jeton d'accès personnel que vous avez déjà créé dans GitHub.

Consultez aussi

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