Tutorial: Configuración de un ejecutor de GitHub Actions alojado en CodeBuild

En este tutorial, se muestra cómo configurar los proyectos de CodeBuild para ejecutar trabajos de GitHub Actions. Para obtener más información sobre cómo usar GitHub Actions con CodeBuild, consulte Tutorial: Configuración de un ejecutor de GitHub Actions alojado en CodeBuild.

Para completar este tutorial, primero debe:

Paso 1: creación de un proyecto de CodeBuild con un webhook

En este paso, va a crear un proyecto de CodeBuild con un webhook y lo revisará en la consola de GitHub. También puede elegir GitHub Enterprise como proveedor de origen. Para obtener más información acerca de cómo crear un webhook en GitHub Enterprise, consulte Webhooks manuales de GitHub.

Paso 2: actualización del YAML del flujo de trabajo de GitHub Actions

En este paso, se va a actualizar el archivo YAML del flujo de trabajo de GitHub Actions en GitHub para configurar el entorno de compilación y usar los ejecutores autoalojados de GitHub Actions en CodeBuild. Para obtener más información, consulte Uso de etiquetas con ejecutores autohospedados y Anulaciones de etiquetas admitidas con el ejecutor de GitHub Actions alojado en CodeBuild.

Actualización del YAML del flujo de trabajo de GitHub Actions

Desplácese hasta GitHub y actualice la configuración de runs-on en el archivo YAML del flujo de trabajo de GitHub Actions para configurar su entorno de compilación. Para ello, puede hacer una de las acciones siguientes:

Ejecución de comandos buildspec durante las fases INSTALL, PRE_BUILD y POST_BUILD

De forma predeterminada, CodeBuild ignora cualquier comando buildspec al ejecutar una compilación de GitHub Actions autoalojada. Para ejecutar comandos buildspec durante la compilación, se puede agregar buildspec-override:true como sufijo a la etiqueta:

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

Con este comando, CodeBuild creará una carpeta llamada actions-runner en la carpeta de origen principal del contenedor. Cuando el ejecutor de GitHub Actions se inicie durante la fase BUILD, este se ejecutará en el directorio actions-runner.

Existen varias limitaciones al usar una anulación de buildspec en una compilación de GitHub Actions autoalojada:

Paso 3: revisión de los resultados

Siempre que se ejecuta un flujo de trabajo de GitHub Actions, CodeBuild recibe los eventos del trabajo del flujo de trabajo a través del webhook. Para cada trabajo del flujo de trabajo, CodeBuild inicia una compilación para utilizar un ejecutor efímero de GitHub Actions. Este es responsable de ejecutar un único trabajo del flujo de trabajo. Una vez que se complete el trabajo, el ejecutor y el proceso de compilación asociado finalizarán de forma inmediata.

Para ver los registros de los trabajos de flujo de trabajo, navegue hasta su repositorio en GitHub, elija Actions, elija el flujo de trabajo que desee y, a continuación, seleccione el elemento Job específico para el que le gustaría revisar los registros.

Puede revisar las etiquetas solicitadas en el registro mientras el trabajo espera a que lo seleccione un ejecutor autoalojado en CodeBuild.

Una vez que se haya completado el trabajo, podrá ver el registro de este.

Opciones de configuración del ejecutor de GitHub Actions

Puede especificar las siguientes variables de entorno en la configuración del proyecto para modificar la configuración de instalación de los ejecutores autoalojados.

Filtrado de eventos de webhook de GitHub Actions (CloudFormation)

La siguiente parte de una plantilla de CloudFormation con formato YAML crea un grupo de filtros que desencadena una compilación cuando se evalúa como true. El siguiente grupo de filtros especifica una solicitud de trabajo de flujo de trabajo de GitHub Actions con un nombre de flujo de trabajo que coincide con la expresión regular \[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\]

Filtrado de eventos de webhook de GitHub Actions (AWS CDK)

La siguiente plantilla de AWS CDK crea un grupo de filtros que desencadena una compilación cuando se evalúa como true. El siguiente grupo de filtros especifica una solicitud de trabajo de flujo de trabajo de 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)],
    })

Filtrado de eventos de webhook de GitHub Actions (Terraform)

La siguiente plantilla de Terraform crea un grupo de filtros que desencadena una compilación cuando se evalúa como true. El siguiente grupo de filtros especifica una solicitud de trabajo de flujo de trabajo de 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"
    }
  }
}

Filtrado de eventos de webhook de GitHub Actions (AWS CLI)

Los siguientes comandos de la AWS CLI crean un proyecto de ejecutor de GitHub Actions autoalojado con un grupo de filtros de solicitudes de trabajo del flujo de trabajo de GitHub Actions que desencadena una compilación cuando se evalúa como true.

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\"}]]"