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 lanceur d' CodeBuild-hosted GitHub actions

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 voirTutoriel : Configuration d'un lanceur d' CodeBuild-hosted GitHub actions.

Pour effectuer ce didacticiel, vous devez d'abord :

É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 consulter 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, consultezGitHub webhooks manuels.

É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 GitHub pour configurer votre environnement de création et utiliser les coureurs auto-hébergés par GitHub Actions dans. CodeBuild Pour plus d'informations, voir Utilisation des étiquettes avec des coureurs auto-hébergés etLes remplacements d'étiquettes sont pris en charge avec le lanceur d' CodeBuild-hosted GitHub actions.

Mettez à jour votre flux de travail GitHub Actions (YAML)

Accédez au runs-on paramètre YAML de votre flux de travail GitHub Actions GitHub et mettez-le à jour pour configurer votre environnement de génération. Pour ce faire, vous pouvez effectuer l'une des opérations suivantes :

Exécutez les commandes buildspec dans les phases INSTALL, PRE_BUILD et POST_BUILD

Par défaut, CodeBuild ignore toutes les commandes buildspec lors de l'exécution d'une version d'Actions GitHub auto-hébergée. Pour exécuter les commandes buildspec pendant la compilation, buildspec-override:true vous pouvez ajouter un suffixe à l'étiquette :

runs-on:
  - codebuild-<project-name>-${{ github.run_id }}-${{ github.run_attempt }}
    buildspec-override:true

À l'aide de cette commande, CodeBuild vous allez créer un dossier appelé actions-runner dans le dossier source principal du conteneur. Lorsque le lanceur GitHub Actions démarre pendant la BUILD phase, il s'exécute dans le actions-runner répertoire.

L'utilisation d'un remplacement buildspec dans une version Actions GitHub auto-hébergée présente plusieurs limites :

Étape 3 : Passez en revue vos résultats

Chaque fois qu'un flux de travail GitHub Actions est exécuté, CodeBuild les événements de la tâche du flux de travail sont reçus via le webhook. Pour chaque tâche du flux de travail, CodeBuild démarre une compilation pour exécuter un lanceur 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 la tâche terminée, le runner 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, choisissez Actions, choisissez le flux de travail souhaité, puis choisissez la tâche spécifique pour laquelle vous souhaitez consulter les journaux.

Vous pouvez consulter les étiquettes demandées dans le journal pendant que la tâche attend d'être prise en charge par un coursier auto-hébergé CodeBuild.

Une fois la tâche terminée, vous pourrez consulter le journal de la tâche.

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 configuration de vos coureurs auto-hébergés.

Filtrer GitHub les actions et les événements du webhook (CloudFormation)

La YAML-formatted partie suivante d'un CloudFormation modèle crée un groupe de filtres qui déclenche une génération lorsqu'il est évalué à true. Le groupe de filtres suivant spécifie une demande de tâche de flux de travail GitHub Actions dont le nom correspond à 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é à true. Le groupe de filtres suivant spécifie une demande de tâche du 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 des é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é à true. Le groupe de filtres suivant spécifie une demande de tâche du 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 du flux de travail GitHub Actions qui déclenche une génération lorsqu'il est évalué comme vrai.

aws codebuild create-project \
--name <project name> \
--source "{\"type\":\"GITHUB\",\"location\":\"<repository 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 "<service role ARN>"

aws codebuild create-webhook \
--project-name <project name> \
--filter-groups "[[{\"type\":\"EVENT\",\"pattern\":\"WORKFLOW_JOB_QUEUED\"}]]"