Eventos de webhooks de GitHub - AWS CodeBuild

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, es posible especificar que se desencadene una compilación solo con 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. Se activa una compilación si algún grupo de filtros da true como resultado, lo que ocurre cuando todos los filtros del grupo dan este resultado. 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, PULL_REQUEST_MERGED, PULL_REQUEST_CLOSED, RELEASED, PRERELEASED y WORKFLOW_JOB_QUEUED. 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.

X-GitHub-EventValor del encabezado 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
pull_request closed y el campo merged es false PULL_REQUEST_CLOSED
push n/a PUSH
release released RELEASED
release prereleased PRERELEASED
workflow_job queued WORKFLOW_JOB_QUEUED
nota

El tipo de evento PULL_REQUEST_REOPENED solo se puede utilizar con GitHub y GitHub Enterprise Server. Los tipos de evento RELEASED y PRERELEASED solo se pueden utilizar con GitHub. Para obtener más información sobre WORKFLOW_JOB_QUEUED, consulte Tutorial: Configuración de un ejecutor de GitHub Actions alojado en CodeBuild.

Uno o más 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 de un grupo asociados con ellos deben dar true como resultado.

ACTOR_ACCOUNT_ID (ACTOR_ID en 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-name o refs/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 evento de 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 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.

TAG_NAME

Un webhook desencadena una compilación cuando el nombre de etiqueta de la versión coincide con el patrón de expresión regular. Se puede usar un filtro TAG_NAME con los eventos de solicitud released y prereleased de GitHub.

RELEASE_NAME

Un webhook desencadena una compilación cuando el nombre de la versión coincide con el patrón de expresión regular. Se puede usar un filtro RELEASE_NAME con los eventos de solicitud released y prereleased de GitHub.

REPOSITORY_NAME

Un webhook desencadena una compilación cuando el nombre del repositorio coincide con el patrón de expresión regular. Un filtro REPOSITORY_NAME solo se puede usar con webhooks de organización o globales de GitHub.

ORGANIZATION_NAME

Un webhook desencadena una compilación cuando el nombre de la organización coincide con el patrón de expresión regular. Un filtro ORGANIZATION_NAME solo se puede usar con webhooks globales de GitHub.

WORKFLOW_NAME

Un webhook desencadena una compilación cuando el nombre del flujo de trabajo coincide con el patrón de expresión regular. Se puede usar un filtro WORKFLOW_NAME con los eventos de solicitudes en cola de trabajo del flujo de trabajo de GitHub Actions.

nota

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

Temas