Activa el esquema de archivo

En esta página se explica el esquema del archivo de activadores de Secure Source Manager. Para obtener instrucciones sobre cómo crear un archivo de activadores, consulta Crear un archivo de activadores.

Un archivo de activadores contiene instrucciones para que Secure Source Manager active los pasos definidos en un archivo de configuración de Cloud Build en función de un evento de solicitud de inserción o extracción en Secure Source Manager.

Puedes configurar tus reglas de protección de ramas para que requieran una comprobación de estado correcta de activadores específicos. Para obtener más información sobre la protección de ramas, consulta el artículo sobre la protección de ramas.

Estructura de un archivo de activadores

El archivo de configuración de los activadores debe crearse en la rama predeterminada de tu repositorio. Puedes escribir el archivo de activadores con la sintaxis YAML.

Un archivo de activadores tiene la siguiente estructura:

triggers:
- name: string
  project: string
  configFilePath: string
  eventType: string
  includedGitRefs: string
  ignoredGitRefs: string
  includedFiles: string
  ignoredFiles: string
  serviceAccount: string
  disabled: bool
  substitutions: map[string]string
- name: string
...

Cada sección con nombre del archivo de activadores define la configuración de Cloud Build que se va a usar para el tipo de evento especificado en Secure Source Manager.

Activadores

Un activador especifica el tipo de evento de Secure Source Manager que quieres usar para activar la finalización de los pasos de un archivo de configuración de Cloud Build específico. También puedes especificar qué ramas se monitorizan para el evento en cuestión.

Usa el campo name del archivo de activadores para identificar un activador. Aquí tienes un ejemplo del tipo de configuración que puedes definir en el archivo de activadores:

triggers:
- name: presubmit-test
  project: my-project
  configFilePath: test.yaml
  eventType: pull_request
  includedGitRefs: ^main$
  ignoredGitRefs: .*log
  serviceAccount: projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com
  includedFiles: .*
  ignoredFiles: my-file.txt
  disabled: false
- name: postsubmit-run
  project: my-project
  configFilePath: run.yaml
  eventType: push
  includedGitRefs: ^main$
  ignoredGitRefs: dev-branch
  serviceAccount: projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com
  disabled: false
  substitutions:
    _NODE_VERSION_1: v6.9.1
    REPO_NAME: dev

name

Obligatorio. Usa el campo name del activador para identificarlo. Los nombres de los activadores solo pueden contener caracteres alfanuméricos y guiones, y no pueden empezar ni terminar con un guion. Los nombres de los activadores deben tener menos de 64 caracteres.

project

Opcional. Usa el campo project para identificar el proyecto en el que has habilitado Cloud Build. Google Cloud

El valor predeterminado es el proyecto de Secure Source Manager.

configFilePath

Opcional. Ruta al archivo de configuración de Cloud Build.

El valor predeterminado es .cloudbuild/cloudbuild.yaml.

eventType

Opcional. El tipo de evento que se activará. Las opciones son push para las inserciones en las ramas seleccionadas o pull_request para las solicitudes de extracción en las ramas seleccionadas.

El valor predeterminado es push.

includedGitRefs

Opcional. Una expresión regular en formato RE2 que coincida con las referencias de Git que activan una compilación.

El valor predeterminado está vacío. Si el campo de filtro includedGitRefs está vacío, significa que no hay restricciones.

Si la referencia de Git no se incluye en el campo de filtro ignoredGitRefs, Secure Source Manager comprueba el campo de filtro includedGitRefs. Si la referencia de Git está en el campo de filtro includedGitRefs, se activa una compilación. Si el campo de filtro includedGitRefs no está vacío y la referencia de Git no se incluye en el campo de filtro includedGitRefs, no se activará ninguna compilación.

ignoredGitRefs

Opcional. Expresión regular en formato RE2 que coincide con las referencias de Git que no deben activar una compilación.

El valor predeterminado está vacío. Si el campo de filtro ignoredGitRefs está vacío, significa que no hay restricciones.

Secure Source Manager comprueba primero el campo de filtro ignoredGitRefs. Si no está vacío y la referencia de Git coincide con el campo de filtro ignoredGitRefs, no se activará ninguna compilación.

serviceAccount

Obligatorio. La cuenta de servicio de Cloud Build que se va a usar en la compilación.

Formato: projects/PROJECT_ID/serviceAccounts/ACCOUNT

Haz los cambios siguientes:

  • PROJECT_ID: con el ID del proyecto Google Cloud en el que has creado la cuenta de servicio.
  • ACCOUNT: con la dirección de correo o el ID único de la cuenta de servicio.

includedFiles

Opcional. Una expresión regular en formato RE2 que coincida con los archivos que deben activar una compilación cuando se modifiquen.

Si los archivos modificados no están en el campo de filtro ignoredFiles y coinciden con el campo de filtro includedFiles, se activará una compilación.

El valor predeterminado está vacío. Si el campo de filtro está vacío, significa que no hay restricciones.

ignoredFiles

Opcional. Una expresión regular con formato RE2 que coincida con los archivos que no deberían activar una compilación cuando se modifiquen.

Si el campo de filtro ignoredFiles no está vacío, las confirmaciones que solo incluyan archivos que coincidan con el campo de filtro ignoredFiles no activarán una compilación. El valor predeterminado es vacío. Un filtro vacío indica que no hay restricciones.

disabled

Opcional. Valor booleano para definir si el activador está inhabilitado o no. Los valores son true y false.

El valor predeterminado es false.

substitutions

Usa sustituciones en el archivo de activadores para sustituir variables específicas en el archivo de configuración de Cloud Build durante el tiempo de compilación.

Las sustituciones deben empezar por un guion bajo y solo pueden contener letras mayúsculas, guiones bajos y números, o bien ser una de las variables de sustitución de Secure Source Manager.

Secure Source Manager proporciona las siguientes variables de sustitución predeterminadas:

  • TRIGGER_NAME: el nombre asociado al activador.
  • COMMIT_SHA: el ID de confirmación asociado al activador.
  • REVISION_ID: el ID de confirmación asociado al activador.
  • SHORT_SHA: los siete primeros caracteres de COMMIT_SHA.
  • REPO_NAME: el nombre del repositorio. Por ejemplo: my-repo.
  • REPO_FULL_NAME: la ruta de recursos del repositorio. Por ejemplo: projects/my-project/locations/us-central/repositories/test-repo.
  • REF_NAME: el nombre de la rama o la etiqueta asociada al activador.
  • TRIGGER_BUILD_CONFIG_PATH: la ruta al archivo de configuración de compilación que se ha usado durante la ejecución de la compilación.

Para obtener información sobre cómo incluir variables de sustitución de Secure Source Manager en tu archivo de configuración de Cloud Build, consulta Sustituir valores de variables.

Siguientes pasos