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.
# Tutoriel : Configuration d'un CodeBuild exécuteur d' GitHub actions hébergé
Ce didacticiel explique comment configurer vos CodeBuild projets pour exécuter GitHub des tâches Actions. Pour plus d'informations sur l'utilisation d' GitHub Actions avec, CodeBuild voir[Tutoriel : Configuration d'un CodeBuild exécuteur d' GitHub actions hébergé](#action-runner).
Pour effectuer ce didacticiel, vous devez d'abord :
+ Connectez-vous à l'aide d'un jeton d'accès personnel, d'un secret du Gestionnaire de Secrets, d'une OAuth application ou d'une GitHub appli. Si vous souhaitez vous connecter à une OAuth application, vous devez utiliser la CodeBuild console pour ce faire. Si vous souhaitez créer un jeton d'accès personnel, vous pouvez utiliser la CodeBuild console ou l'[ImportSourceCredentials API](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_ImportSourceCredentials.html). Pour plus d’informations, consultez [GitHub et accès au serveur d' GitHub entreprise dans CodeBuild](access-tokens-github-overview.md).
+ Connectez-vous CodeBuild à votre GitHub compte. Pour ce faire, vous pouvez effectuer l'une des opérations suivantes :
+ Vous pouvez l'ajouter GitHub en tant que fournisseur de source dans la console. Vous pouvez vous connecter à l'aide d'un jeton d'accès personnel, d'un secret du Gestionnaire de Secrets, d'une OAuth application ou d'une GitHub application. Pour obtenir des instructions, veuillez consulter [GitHub et accès au serveur d' GitHub entreprise dans CodeBuild](access-tokens-github-overview.md).
+ Vous pouvez importer vos GitHub informations d'identification via l'[ImportSourceCredentials API](https://docs.aws.amazon.com/cli/latest/reference/codebuild/import-source-credentials.html). Cela ne peut être fait qu'avec un jeton d'accès personnel. Si vous vous connectez à l'aide d'une OAuth application, vous devez plutôt vous connecter à l'aide de la console. Pour obtenir des instructions, veuillez consulter [Connectez-vous à GitHub l'aide d'un jeton d'accès (CLI)](access-tokens-github.md#access-tokens-github-cli).
**Note**
Cela ne doit être fait que si vous n'êtes pas connecté GitHub à votre compte.
## Étape 1 : Création d'un CodeBuild projet avec un webhook
Au cours de cette étape, vous allez créer un CodeBuild projet avec un webhook et le passer en revue dans la GitHub console. Vous pouvez également choisir GitHub Enterprise comme fournisseur source. Pour en savoir plus sur la création d'un webhook dans GitHub Enterprise, consultez[GitHub webhooks manuels](github-manual-webhook.md).
**Pour créer un CodeBuild projet avec un webhook**
1. Ouvrez la AWS CodeBuild console sur [https://console.aws.amazon.com/codesuite/codebuild/home](https://console.aws.amazon.com/codesuite/codebuild/home).
1. Créez un projet de génération. Pour plus d’informations, consultez [Création d'un projet de génération (console)](create-project.md#create-project-console) et [Exécution d'une génération (console)](run-build-console.md).
1. Dans **Type de projet**, choisissez le **projet Runner**.
Dans **Runner** :
1. Pour le **fournisseur Runner**, choisissez **GitHub**.
1. Pour l'**emplacement de Runner**, choisissez **Repository**.
1. Pour URL du référentiel sous **Repository**, choisissez **https://github.com/user-name/repository-name**.
**Note**
Par défaut, votre projet ne recevra que les `WORKFLOW_JOB_QUEUED` événements d'un seul référentiel. Si vous souhaitez recevoir des événements pour tous les référentiels d'une organisation ou d'une entreprise, consultez[GitHub webhooks mondiaux et organisationnels](github-global-organization-webhook.md).
1.
+ Dans **Environment (Environnement)** :
+ Choisissez une **image d'environnement** compatible et **calculez**. Notez que vous avez la possibilité de remplacer les paramètres d'image et d'instance en utilisant une étiquette dans le code YAML de votre flux de travail GitHub Actions. Pour de plus amples informations, consultez [Étape 2 : mettez à jour votre flux de travail GitHub Actions YAML](#sample-github-action-runners-update-yaml).
+ Dans **Buildspec**:
+ Notez que votre spécification de construction sera ignorée à moins qu'elle ne `buildspec-override:true` soit ajoutée sous forme d'étiquette. Au lieu de cela, il le CodeBuild remplacera pour utiliser des commandes qui configureront le coureur auto-hébergé.
1. Continuez avec les valeurs par défaut, puis choisissez **Create build project**.
1. Ouvrez la GitHub console sur `https://github.com/user-name/repository-name/settings/hooks` pour vérifier qu'un webhook a été créé et qu'il est activé pour diffuser des événements de **tâches Workflow**.
## Étape 2 : mettez à jour votre flux de travail GitHub Actions YAML
Au cours de cette étape, vous allez mettre à jour le fichier YAML de votre flux de travail GitHub Actions [https://github.com/](https://github.com/)pour configurer votre environnement de construction et utiliser les coureurs auto-hébergés par GitHub Actions dans. CodeBuild Pour plus d'informations, consultez les sections [Utilisation d'étiquettes avec des coureurs auto-hébergés](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners) et[Les remplacements d'étiquettes sont pris en charge avec le programme Actions Runner CodeBuild hébergé par -hosted GitHub](sample-github-action-runners-update-labels.md).
### Mettez à jour votre flux de travail GitHub Actions (YAML)
Accédez au [https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners)paramètre YAML de votre flux de travail GitHub Actions [https://github.com/](https://github.com/)et mettez-le à jour pour configurer votre environnement de génération. Pour ce faire, vous pouvez effectuer l'une des opérations suivantes :
+ Vous pouvez spécifier le nom du projet et l'ID d'exécution, auquel cas le build utilisera la configuration de votre projet existante pour le calcul, l'image, la version de l'image et la taille de l'instance. Le nom du projet est nécessaire pour lier AWS les paramètres associés de votre tâche GitHub Actions à un CodeBuild projet spécifique. En incluant le nom du projet dans le YAML, CodeBuild il est autorisé à invoquer des tâches avec les paramètres de projet corrects. En fournissant l'ID d'exécution, votre build CodeBuild sera mappé à des exécutions de flux de travail spécifiques et arrêtera la génération lorsque l'exécution du flux de travail est annulée. Pour plus d'informations, reportez-vous à la section [`github`Contexte](https://docs.github.com/en/actions/learn-github-actions/contexts#github-context).
```
runs-on: codebuild--${{ github.run_id }}-${{ github.run_attempt }}
```
**Note**
Assurez-vous que vous ** correspondez au nom du projet que vous avez créé à l'étape précédente. S'il ne correspond pas, le webhook ne CodeBuild sera pas traité et le flux de travail GitHub Actions risque de se bloquer.
Voici un exemple de flux de travail GitHub Actions YAML :
```
name: Hello World
on: [push]
jobs:
Hello-World-Job:
runs-on:
- codebuild-myProject-${{ github.run_id }}-${{ github.run_attempt }}
steps:
- run: echo "Hello World!"
```
+ Vous pouvez également remplacer votre image et le type de calcul dans l'étiquette. Consultez [Calculez les images prises en charge avec le CodeBuild lanceur d' GitHub actions hébergé](sample-github-action-runners-update-yaml.images.md) la liste des images sélectionnées. Pour utiliser des images personnalisées, voir[Les remplacements d'étiquettes sont pris en charge avec le programme Actions Runner CodeBuild hébergé par -hosted GitHub](sample-github-action-runners-update-labels.md). Le type de calcul et l'image figurant dans l'étiquette remplaceront les paramètres d'environnement de votre projet. Pour remplacer les paramètres de votre environnement pour une version de calcul CodeBuild EC2 ou Lambda, utilisez la syntaxe suivante :
```
runs-on:
- codebuild--${{ github.run_id }}-${{ github.run_attempt }}
image:-
instance-size:
```
Voici un exemple de flux de travail GitHub Actions YAML :
```
name: Hello World
on: [push]
jobs:
Hello-World-Job:
runs-on:
- codebuild-myProject-${{ github.run_id }}-${{ github.run_attempt }}
image:arm-3.0
instance-size:small
steps:
- run: echo "Hello World!"
```
+ Vous pouvez remplacer le parc utilisé pour votre construction dans l'étiquette. Cela remplacera les paramètres de flotte configurés dans votre projet pour utiliser le parc spécifié. Pour de plus amples informations, veuillez consulter [Exécutez des builds sur des flottes à capacité réservée](fleets.md). Pour remplacer les paramètres de votre flotte pour une version de calcul Amazon EC2, utilisez la syntaxe suivante :
```
runs-on:
- codebuild--${{ github.run_id }}-${{ github.run_attempt }}
fleet:
```
Pour remplacer à la fois la flotte et l'image utilisées pour la génération, utilisez la syntaxe suivante :
```
runs-on:
- codebuild--${{ github.run_id }}-${{ github.run_attempt }}
fleet:
image:-
```
Voici un exemple de flux de travail GitHub Actions YAML :
```
name: Hello World
on: [push]
jobs:
Hello-World-Job:
runs-on:
- codebuild-myProject-${{ github.run_id }}-${{ github.run_attempt }}
fleet:myFleet
image:arm-3.0
steps:
- run: echo "Hello World!"
```
+ Pour exécuter vos tâches GitHub Actions sur une image personnalisée, vous pouvez configurer une image personnalisée dans votre CodeBuild projet et éviter de fournir une étiquette de remplacement d'image. CodeBuild utilisera l'image configurée dans le projet si aucune étiquette de remplacement d'image n'est fournie.
+ Vous pouvez éventuellement fournir des étiquettes autres que celles prises CodeBuild en charge. Ces étiquettes seront ignorées dans le but de remplacer les attributs de la version, mais elles n'échoueront pas à la demande de webhook. Par exemple, l'ajout `testLabel` d'une étiquette n'empêchera pas le build de s'exécuter.
**Note**
Si une dépendance fournie par GitHub -hosted runners n'est pas disponible dans l' CodeBuildenvironnement, vous pouvez l'installer à l'aide d' GitHub Actions dans votre flux de travail. Par exemple, vous pouvez utiliser l'[https://github.com/actions/setup-python](https://github.com/actions/setup-python)action pour installer Python dans votre environnement de construction.
### Exécutez les commandes buildspec pendant les phases INSTALL, PRE\$1BUILD et POST\$1BUILD
Par défaut, CodeBuild ignore les commandes buildspec lors de l'exécution d'une version Actions auto-hébergée. GitHub Pour exécuter les commandes buildspec pendant la construction, `buildspec-override:true` vous pouvez les ajouter en tant que suffixe à l'étiquette :
```
runs-on:
- codebuild--${{ github.run_id }}-${{ github.run_attempt }}
buildspec-override:true
```
En utilisant cette commande, CodeBuild vous créerez un dossier appelé `actions-runner` dans le dossier source principal du conteneur. Lorsque le lanceur d' GitHub actions démarre pendant la `BUILD` phase, il s'exécute dans le `actions-runner` répertoire.
L'utilisation d'une dérogation buildspec dans une version Actions auto-hébergée présente plusieurs limites : GitHub
+ CodeBuild n'exécutera pas de commandes buildspec pendant la `BUILD` phase, car le lanceur auto-hébergé s'exécute pendant la phase. `BUILD`
+ CodeBuild ne téléchargera aucune source principale ou secondaire pendant la `DOWNLOAD_SOURCE` phase. Si vous avez configuré un fichier buildspec, seul ce fichier sera téléchargé depuis la source principale du projet.
+ Si une commande de génération échoue pendant la `INSTALL` phase `PRE_BUILD` ou, elle ne CodeBuild démarrera pas le lanceur auto-hébergé et le travail du flux de travail GitHub Actions devra être annulé manuellement.
+ CodeBuild récupère le jeton du coureur pendant la `DOWNLOAD_SOURCE` phase, dont le délai d'expiration est d'une heure. Si votre `PRE_BUILD` ou vos `INSTALL` phases dépassent une heure, le jeton de course peut expirer avant le départ du coureur GitHub auto-hébergé.
## Étape 3 : Passez en revue vos résultats
Chaque fois qu'un flux de travail GitHub Actions est exécuté, CodeBuild il reçoit les événements de travail du flux de travail via le webhook. Pour chaque tâche du flux de travail, CodeBuild lance une compilation pour exécuter un exécuteur d' GitHub actions éphémère. Le coureur est responsable de l'exécution d'une seule tâche de flux de travail. Une fois le travail terminé, le lanceur et le processus de construction associé seront immédiatement interrompus.
Pour consulter les journaux des tâches de votre flux de travail GitHub, accédez à votre référentiel dans, choisissez **Actions**, choisissez le flux de travail souhaité, puis choisissez le **travail** spécifique dont vous souhaitez consulter les journaux.
Vous pouvez consulter les étiquettes demandées dans le journal pendant que le travail attend d'être récupéré par un coureur auto-hébergé. CodeBuild
![\[Chargement du journal de la tâche.\]](http://docs.aws.amazon.com/fr_fr/codebuild/latest/userguide/images/hello-world-loading.png)
Une fois la tâche terminée, vous pourrez consulter le journal de la tâche.
![\[Le journal de la tâche.\]](http://docs.aws.amazon.com/fr_fr/codebuild/latest/userguide/images/hello-world-log.png)
## GitHub Options de configuration d'Actions Runner
Vous pouvez spécifier les variables d'environnement suivantes dans la configuration de votre projet pour modifier la configuration de vos coureurs auto-hébergés.
`CODEBUILD_CONFIG_GITHUB_ACTIONS_ORG_REGISTRATION_NAME`
CodeBuild enregistrera les coureurs auto-hébergés au nom de l'organisation spécifié comme valeur de cette variable d'environnement. Pour plus d'informations sur l'enregistrement des coureurs au niveau de l'organisation et sur les autorisations nécessaires, voir [Créer une configuration pour un just-in-time coureur au sein d'une organisation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#create-configuration-for-a-just-in-time-runner-for-an-organization).
`CODEBUILD_CONFIG_GITHUB_ACTIONS_ENTERPRISE_REGISTRATION_NAME`
CodeBuild enregistrera les coureurs auto-hébergés sous le nom d'entreprise spécifié comme valeur de cette variable d'environnement. Pour plus d'informations sur l'enregistrement des coureurs au niveau de l'entreprise et sur les autorisations nécessaires, voir [Créer une configuration pour un just-in-time coureur pour une entreprise](https://docs.github.com/en/enterprise-server/rest/actions/self-hosted-runners?apiVersion=2022-11-28#create-configuration-for-a-just-in-time-runner-for-an-enterprise).
Par défaut, les Enterprise Runners ne sont pas disponibles dans les référentiels de l'organisation. Pour que les coureurs auto-hébergés puissent prendre en charge les tâches liées au flux de travail, vous devrez peut-être configurer les paramètres d'accès de votre groupe de coureurs. Pour plus d'informations, consultez la section Mise [à disposition des Enterprise Runners dans les référentiels.](https://docs.github.com/en/enterprise-server/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners#making-enterprise-runners-available-to-repositories)
`CODEBUILD_CONFIG_GITHUB_ACTIONS_RUNNER_GROUP_ID`
CodeBuild enregistrera les coureurs auto-hébergés selon l'identifiant entier du groupe de coureurs stocké sous forme de valeur de cette variable d'environnement. Par défaut, cette valeur est 1. Pour plus d'informations sur les groupes de coureurs auto-hébergés, voir [Gestion de l'accès aux coureurs auto-hébergés à l'aide](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#create-configuration-for-a-just-in-time-runner-for-an-organization) de groupes.
`CODEBUILD_CONFIG_GITHUB_ACTIONS_ORG_REGISTRATION_NAME`
Pour configurer l'enregistrement des coureurs au niveau de l'organisation à l'aide du fichier YAML de votre flux de travail GitHub Actions, vous pouvez utiliser la syntaxe suivante :
```
name: Hello World
on: [push]
jobs:
Hello-World-Job:
runs-on:
- codebuild-myProject-${{ github.run_id }}-${{ github.run_attempt }}
organization-registration-name:myOrganization
steps:
- run: echo "Hello World!"
```
`CODEBUILD_CONFIG_GITHUB_ACTIONS_ENTERPRISE_REGISTRATION_NAME`
Pour configurer l'enregistrement des coureurs au niveau de l'entreprise à l'aide du fichier YAML de votre flux de travail GitHub Actions, vous pouvez utiliser la syntaxe suivante :
```
name: Hello World
on: [push]
jobs:
Hello-World-Job:
runs-on:
- codebuild-myProject-${{ github.run_id }}-${{ github.run_attempt }}
enterprise-registration-name:myEnterprise
steps:
- run: echo "Hello World!"
```
`CODEBUILD_CONFIG_GITHUB_ACTIONS_RUNNER_GROUP_ID`
Pour configurer l'enregistrement des coureurs à un identifiant de groupe de coureurs spécifique à l'aide du fichier YAML de votre flux de travail GitHub Actions, vous pouvez utiliser la syntaxe suivante :
```
name: Hello World
on: [push]
jobs:
Hello-World-Job:
runs-on:
- codebuild-myProject-${{ github.run_id }}-${{ github.run_attempt }}
registration-group-id:3
steps:
- run: echo "Hello World!"
```
## Filtrer GitHub les actions et les événements du webhook ()CloudFormation
La partie suivante d'un CloudFormation modèle au format YAML crée un groupe de filtres qui déclenche une génération lorsqu'elle est évaluée à true. Le groupe de filtres suivant spécifie une demande de travail de flux de travail GitHub Actions avec un nom de flux de travail correspondant à l'expression régulière`\[CI-CodeBuild\]`.
```
CodeBuildProject:
Type: AWS::CodeBuild::Project
Properties:
Name: MyProject
ServiceRole: service-role
Artifacts:
Type: NO_ARTIFACTS
Environment:
Type: LINUX_CONTAINER
ComputeType: BUILD_GENERAL1_SMALL
Image: aws/codebuild/standard:5.0
Source:
Type: GITHUB
Location: CODEBUILD_DEFAULT_WEBHOOK_SOURCE_LOCATION
Triggers:
Webhook: true
ScopeConfiguration:
Name: organization-name
Scope: GITHUB_ORGANIZATION
FilterGroups:
- - Type: EVENT
Pattern: WORKFLOW_JOB_QUEUED
- Type: WORKFLOW_NAME
Pattern: \[CI-CodeBuild\]
```
## Filtrer GitHub les actions et les événements du webhook ()AWS CDK
Le AWS CDK modèle suivant crée un groupe de filtres qui déclenche une génération lorsqu'il est évalué comme vrai. Le groupe de filtres suivant spécifie une demande de travail dans le flux de travail GitHub Actions.
```
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
import {EventAction, FilterGroup} from "aws-cdk-lib/aws-codebuild";
const source = codebuild.Source.gitHub({
owner: 'owner',
repo: 'repo',
webhook: true,
webhookFilters: [FilterGroup.inEventOf(EventAction.WORKFLOW_JOB_QUEUED)],
})
```
## Filtrer GitHub les actions et les événements du webhook (Terraform)
Le modèle Terraform suivant crée un groupe de filtres qui déclenche une génération lorsqu'il est évalué comme vrai. Le groupe de filtres suivant spécifie une demande de travail dans le flux de travail GitHub Actions.
```
resource "aws_codebuild_webhook" "example" {
project_name = aws_codebuild_project.example.name
build_type = "BUILD"
filter_group {
filter {
type = "EVENT"
pattern = "WORKFLOW_JOB_QUEUED"
}
}
}
```
## Filtrer GitHub les actions et les événements du webhook ()AWS CLI
Les AWS CLI commandes suivantes créent un projet GitHub Actions Runner auto-hébergé avec un groupe de filtres de demandes de travail GitHub Actions Workflow qui déclenche une compilation lorsqu'elle est évaluée comme vraie.
```
aws codebuild create-project \
--name \
--source "{\"type\":\"GITHUB\",\"location\":\"\",\"buildspec\":\"\"}" \
--artifacts {"\"type\":\"NO_ARTIFACTS\""} \
--environment "{\"type\": \"LINUX_CONTAINER\",\"image\": \"aws/codebuild/amazonlinux-x86_64-standard:5.0\",\"computeType\": \"BUILD_GENERAL1_MEDIUM\"}" \
--service-role ""
```
```
aws codebuild create-webhook \
--project-name \
--filter-groups "[[{\"type\":\"EVENT\",\"pattern\":\"WORKFLOW_JOB_QUEUED\"}]]"
```