eventos de webhooks de GitHub - AWS CodeBuild

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

eventos de webhooks de GitHub

Puede utilizar grupos de filtros de webhooks para especificar qué eventos de webhooks de GitHub van a desencadenar una compilación. Por ejemplo, puede especificar que se desencadene una compilación únicamente con los cambios en ramificaciones específicas.

Puede crear uno o varios grupos de filtros de webhooks para especificar qué eventos de webhooks van a desencadenar una compilación. Si todos los filtros de uno o varios grupos se evalúan como true, se desencadenará una compilación. Cuando cree un grupo de filtros, deberá especificar:

Un evento

En GitHub, puede seleccionar uno o varios de los siguientes eventos: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED y PULL_REQUEST_MERGED. El tipo de evento de webhook está en el encabezado X-GitHub-Event de la carga de webhook. En el encabezado X-GitHub-Event, es posible que vea pull_request o push. Para un evento de solicitud de extracción, el tipo está en el campo action de la carga del evento de webhook. En la siguiente tabla se muestra cómo los valores del encabezado X-GitHub-Event y los valores del campo action de la carga de solicitud de extracción de webhook se asignan a los tipos de eventos disponibles.

Valor del encabezado X-GitHub-Event Valor action de la carga del evento de webhook Tipo de evento
pull_request opened PULL_REQUEST_CREATED
pull_request reopened PULL_REQUEST_REOPENED
pull_request synchronize PULL_REQUEST_UPDATED
pull_request closed y el campo merged es true PULL_REQUEST_MERGED
push n/a PUSH
nota

El tipo de evento PULL_REQUEST_REOPENED solo se puede utilizar con GitHub y GitHub Enterprise Server.

Uno o varios filtros opcionales

Utilice una expresión regular para especificar los filtros. En el caso de los eventos que desencadenan una compilación, todos los filtros asociados con ellos deben evaluarse como true.

ACTOR_ACCOUNT_ID(ACTOR_IDen la consola)

Un evento de webhook desencadena una compilación cuando el ID de una cuenta de GitHub o GitHub Enterprise Server coincide con el patrón de la expresión regular. Este valor se encuentra en la propiedad id del objeto sender en la carga de webhook.

HEAD_REF

Un evento de webhook desencadena una compilación cuando la referencia del encabezado coincide con el patrón de la expresión regular (por ejemplo,refs/heads/branch-nameorefs/tags/tag-name). Para un evento, el nombre de referencia se encuentra en la propiedad ref de la carga de webhook. Para los eventos de solicitud de extracción, el nombre de la ramificación se encuentra en la propiedad ref del objeto head de la carga de webhook.

BASE_REF

Un evento de webhook desencadena una compilación cuando la referencia de base coincide con el patrón de la expresión regular (por ejemplo,refs/heads/branch-name). Un filtro BASE_REF solo se puede utilizar con eventos de solicitud de extracción. El nombre de la ramificación se encuentra en la propiedad ref del objeto base de la carga de webhook.

FILE_PATH

Un webhook desencadena una compilación cuando la ruta de un archivo modificado coincide con el patrón de la expresión regular. Un filtro FILE_PATH se puede usar con eventos de solicitud de inserción y extracción de GitHub y eventos de inserción de GitHub Enterprise Server. No se puede usar con eventos de solicitud de extracción de GitHub Enterprise Server.

COMMIT_MESSAGE

Un webhook desencadena una compilación cuando el mensaje de confirmación del encabezado coincide con el patrón de la expresión regular. Un filtro COMMIT_MESSAGE se puede usar con eventos de solicitud de inserción y extracción de GitHub y eventos de inserción de GitHub Enterprise Server. No se puede usar con eventos de solicitud de extracción de GitHub Enterprise Server.

nota

Puede encontrar la carga de webhook en la configuración de webhook del repositorio de GitHub.

Filtrar eventos de webhooks en GitHub (consola)

EnEventos de webhooks de código fuente principal, seleccione lo siguiente. Esta sección solo está disponible cuando eligesRepositorio en mi cuenta de GitHubpara el repositorio de código fuente.

  1. Cuando cree el proyecto, seleccione Rebuild every time a code change is pushed to this repository (Volver a compilar cada vez que se inserte un cambio de código en este repositorio).

  2. En Event type (Tipo de evento), seleccione uno o varios eventos.

  3. Para filtrar en función de cuándo un evento va a desencadenar una compilación, en Start a build under these conditions (Iniciar una compilación en estas condiciones), añada uno o varios filtros opcionales.

  4. Para filtrar en función de cuándo no se va a desencadenar un evento, en Don't start a build under these conditions (No iniciar una compilación en estas condiciones), añada uno o varios filtros opcionales.

  5. ElegirAñadir grupo de filtrospara añadir otro grupo de filtros, si es necesario.

Para obtener más información, consulte Creación de un proyecto de compilación (consola) y WebhookFilter en la Referencia de la API de AWS CodeBuild.

En este ejemplo, un grupo de filtros de webhooks desencadena una compilación únicamente con solicitudes de extracción:

Si utilizamos un ejemplo con dos grupos de filtros de webhooks, la compilación se desencadenará cuando uno de los grupos o los dos se evalúen como true:

  • El primer grupo de filtros especifica las solicitudes de extracción que se crean, actualizan o vuelven a abrirse en ramificaciones con nombres de referencia de Git que coinciden con la expresión regular ^refs/heads/main$ y las referencias de encabezado que coinciden con ^refs/heads/branch1$.

  • El segundo grupo de filtros especifica solicitudes de inserción en ramificaciones con nombres de referencia de Git que coinciden con la expresión regular ^refs/heads/branch1$.

En este ejemplo, un grupo de filtros de webhooks desencadena una compilación de todas las solicitudes excepto los eventos de etiquetas.

En este ejemplo, un grupo de filtros de webhooks desencadena una compilación solo cuando se modifican los archivos cuyos nombres coinciden con la expresión regular ^buildspec.*.

En este ejemplo, un grupo de filtros de webhooks desencadena una compilación solamente cuando hay un cambio realizado por un usuario de GitHub o GitHub Enterprise Server especificado que tiene un ID de cuenta que coincide con la expresión regular actor-account-id.

nota

Para obtener información acerca de cómo encontrar el ID de cuenta de GitHub, consulte https://api.github.com/users/nombre-usuario, donde nombre-usuario es el nombre de usuario de GitHub.

En este ejemplo, un grupo de filtros de webhook desencadena una compilación para un evento de inserción cuando el mensaje de confirmación de la cabeza coincide con la expresión regular \[CodeBuild\].

Filtrar eventos de webhooks en GitHub (SDK)

Si desea utilizar el SDK de AWS CodeBuild para filtrar eventos de webhooks, utilice el campo filterGroups de la sintaxis de la solicitud de los métodos de API CreateWebhook o UpdateWebhook. Para obtener más información, consulteWebhookFilteren laReferencia de la API de Code.

Si desea crear un filtro de webhook que desencadene una compilación únicamente con las solicitudes de extracción, inserte lo siguiente en la sintaxis de la solicitud:

"filterGroups": [ [ { "type": "EVENT", "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED" } ] ]

Si desea crear un filtro de webhooks que desencadene una compilación únicamente con las ramificaciones especificadas, utilice el parámetro pattern para especificar una expresión regular que filtre los nombres de las ramificaciones. Si utilizamos un ejemplo con dos grupos de filtros, la compilación se desencadenaría cuando uno de los grupos o los dos se evalúen como true:

  • El primer grupo de filtros especifica las solicitudes de extracción que se crean, actualizan o vuelven a abrirse en ramificaciones con nombres de referencia de Git que coinciden con la expresión regular ^refs/heads/main$ y las referencias de encabezado que coinciden con ^refs/heads/myBranch$.

  • El segundo grupo de filtros especifica solicitudes de inserción en ramificaciones con nombres de referencia de Git que coinciden con la expresión regular ^refs/heads/myBranch$.

"filterGroups": [ [ { "type": "EVENT", "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED" }, { "type": "HEAD_REF", "pattern": "^refs/heads/myBranch$" }, { "type": "BASE_REF", "pattern": "^refs/heads/main$" } ], [ { "type": "EVENT", "pattern": "PUSH" }, { "type": "HEAD_REF", "pattern": "^refs/heads/myBranch$" } ] ]

Puede utilizar el parámetro excludeMatchedPattern para especificar qué eventos no desencadenan una compilación. Por ejemplo, en este caso, se desencadena una compilación con todas las solicitudes, excepto los eventos de etiquetas.

"filterGroups": [ [ { "type": "EVENT", "pattern": "PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED" }, { "type": "HEAD_REF", "pattern": "^refs/tags/.*", "excludeMatchedPattern": true } ] ]

Puede crear un filtro que desencadene una compilación solo cuando se modifiquen los archivos cuyos nombres coincidan con la expresión regular del argumento pattern. En este ejemplo, el grupo de filtros especifica que la compilación solo debe desencadenarse cuando se modifiquen los archivos cuyos nombres coincidan con la expresión regular ^buildspec.*.

"filterGroups": [ [ { "type": "EVENT", "pattern": "PUSH" }, { "type": "FILE_PATH", "pattern": "^buildspec.*" } ] ]

Puede crear un filtro que desencadene una compilación solo cuando un usuario de GitHub o GitHub Enterprise Server especificado con el ID de cuenta actor-account-id realice algún cambio.

nota

Para obtener información acerca de cómo encontrar el ID de cuenta de GitHub, consulte https://api.github.com/users/nombre-usuario, donde nombre-usuario es el nombre de usuario de GitHub.

"filterGroups": [ [ { "type": "EVENT", "pattern": "PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED" }, { "type": "ACTOR_ACCOUNT_ID", "pattern": "actor-account-id" } ] ]

Puede crear un filtro que desencadene una compilación solo cuando el mensaje de confirmación del encabezado coincida con la expresión regular en el argumento pattern. En este ejemplo, el grupo de filtros especifica que una compilación se desencadena solo cuando el mensaje de confirmación del encabezado del evento de inserción coincide con la expresión regular \[CodeBuild\].

"filterGroups": [ [ { "type": "EVENT", "pattern": "PUSH" }, { "type": "COMMIT_MESSAGE", "pattern": "\[CodeBuild\]" } ] ]

Filtrar eventos de webhooks en GitHub (AWS CloudFormation)

Si desea usar una plantilla de AWS CloudFormation para filtrar eventos de webhooks, utilice la propiedad FilterGroups del proyecto de AWS CodeBuild. El siguiente fragmento con formato YAML de una plantilla AWS CloudFormation crea dos grupos de filtros. Juntos, desencadenan una compilación cuando uno de los grupos o los dos se evalúan como true:

  • El primer grupo de filtros especifica las solicitudes de extracción creadas o actualizadas en ramificaciones con nombres de referencia que coinciden con la expresión regular ^refs/heads/main$ por un usuario de Git que no tiene el ID de cuenta 12345.

  • El segundo grupo de filtros especifica las solicitudes de inserción que se crean en archivos cuyos nombres coinciden con la expresión regular READ_ME en las ramificaciones que tienen un nombre que coincide con la expresión regular ^refs/heads/.*.

  • El tercer grupo de filtros especifica una solicitud de inserción con un mensaje de confirmación del encabezado que coincida con la expresión regular \[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:4.0 Source: Type: GITHUB Location: source-location Triggers: Webhook: true FilterGroups: - - Type: EVENT Pattern: PULL_REQUEST_CREATED,PULL_REQUEST_UPDATED - Type: BASE_REF Pattern: ^refs/heads/main$ ExcludeMatchedPattern: false - Type: ACTOR_ACCOUNT_ID Pattern: 12345 ExcludeMatchedPattern: true - - Type: EVENT Pattern: PUSH - Type: HEAD_REF Pattern: ^refs/heads/.* - Type: FILE_PATH Pattern: READ_ME ExcludeMatchedPattern: true - - Type: EVENT Pattern: PUSH - Type: COMMIT_MESSAGE Pattern: \[CodeBuild\]