Crea un archivo de activadores

En esta página, se describen los pasos para crear un archivo YAML de activadores en Secure Source Manager. Se puede usar un archivo de activadores para automatizar compilaciones en función de eventos de envío y solicitud de extracción en un repositorio de Secure Source Manager.

Para obtener información sobre los campos que puedes incluir en un archivo de activadores, lee Esquema del archivo de activadores.

Antes de comenzar

  1. Crea una instancia de Secure Source Manager.
  2. Crea un repositorio de Secure Source Manager.
  3. Lee el Esquema del archivo de activadores para obtener información sobre los campos que puedes incluir en un archivo de activadores.

Roles obligatorios

Para obtener los permisos que necesitas para crear un archivo de activadores, pídele a tu administrador que te otorgue los siguientes roles de IAM:

Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.

Crea un archivo de configuración de Cloud Build

Los archivos de activadores de Secure Source Manager requieren que especifiques un archivo de configuración de compilación para cada activador.

Los archivos de configuración de compilación contienen instrucciones para que Cloud Build realice tareas en función de tus especificaciones. Por ejemplo, el archivo de configuración de compilación puede contener instrucciones para compilar, enviar y empaquetar imágenes de Docker.

Crea tus archivos de configuración de compilación en la rama o las ramas desde las que deseas compilar. Para crear tus archivos de configuración de compilación, sigue las instrucciones que se indican en Crea un archivo de configuración de compilación.

Crea un archivo de activadores

El archivo de configuración de activadores se debe crear en la rama predeterminada de tu repositorio.

Para crear un archivo de configuración de activadores, sigue estos pasos:

  1. En tu repositorio local o en la interfaz web de Secure Source Manager, cambia a la rama predeterminada.

  2. Crea un archivo llamado .cloudbuild/triggers.yaml.

  3. Configura tu activador en el archivo .cloudbuild/triggers.yaml:

    triggers:
- name: TRIGGER_NAME
  project: PROJECT_ID
  configFilePath: CLOUD_BUILD_CONFIG_PATH
  eventType: EVENT_TYPE
  ignoredGitRefs: IGNORED_GIT_REFS
  includedGitRefs: INCLUDED_GIT_REFS
  serviceAccount: SERVICE_ACCOUNT
  includedFiles: INCLUDED_FILES
  ignoredFiles: IGNORED_FILES
  disabled: DISABLED_BOOL
  substitutions:
    _VARIABLE_NAME: VARIABLE_VALUE
    OVERRIDE_VARIABLE_NAME: OVERRIDE_VARIABLE_VALUE

    Reemplaza lo siguiente:

    • TRIGGER_NAME por un nombre para tu activador. Los nombres de los activadores solo pueden contener caracteres alfanuméricos y guiones, y no pueden comenzar ni terminar con un guion. Los nombres de los activadores deben tener menos de 64 caracteres.
    • PROJECT_ID por el Google Cloud ID del proyecto en el que habilitaste Cloud Build. Este campo es opcional. El valor predeterminado es el proyecto de Secure Source Manager.
    • CLOUD_BUILD_CONFIG_PATH por la ruta de acceso al archivo de configuración de Cloud Build que deseas usar para este activador. Este campo es opcional. El valor predeterminado es .cloudbuild/cloudbuild.yaml.

    • EVENT_TYPE por el tipo de evento que deseas activar la compilación. Las opciones son las siguientes:

      • push para activar el envío a las ramas especificadas
      • pull_request para activar una solicitud de extracción a las ramas especificadas

      Este campo es opcional. El valor predeterminado es push.

    • INCLUDED_GIT_REFS con un formato de expresión regular RE2 opcional que coincida con las referencias de Git que deseas activar una compilación. El valor predeterminado es vacío. Un valor vacío indica que no hay restricciones.

    • IGNORED_GIT_REFS por una expresión regular opcional con el formato de expresión regular RE2 que coincida con las referencias de Git que no deseas activar una compilación. El valor predeterminado es vacío. Un valor vacío indica que no hay restricciones. El campo ignoredGitRefs se verifica antes que el campo includedGitRefs. Para obtener más información sobre estos campos, consulta Esquema del archivo de activadores.

    • SERVICE_ACCOUNT por la cuenta de servicio de Cloud Build que se usará para la compilación en el formato projects/PROJECT_ID/serviceAccounts/ACCOUNT. Reemplaza ACCOUNT por la dirección de correo electrónico o el ID único de la cuenta de servicio. Puedes usar la cuenta de servicio predeterminada de Cloud Build o una cuenta de servicio administrada por el usuario. La cuenta de servicio heredada de Cloud Build no se puede usar debido a sus limitaciones.

    • INCLUDED_FILES por una expresión regular de formato RE2 opcional que coincida con los archivos que deseas activar una compilación.

      Si alguno de los archivos modificados no coincide con el campo de filtro ignoredFiles y los archivos modificados coinciden con el campo de filtro includedFiles, se activa una compilación. El valor predeterminado es vacío. Un valor vacío indica que no hay restricciones.

    • IGNORED_FILES por una expresión regular de formato RE2 opcional que coincida con los archivos que no deseas activar una compilación.

      Si todos los archivos modificados en una confirmación coinciden con este campo de filtro, no se activa una compilación. El valor predeterminado es vacío. Un valor vacío indica que no hay restricciones.

    • DISABLED_BOOL por true para inhabilitar el activador o false para habilitarlo. Este campo es opcional. El valor predeterminado es false.

    • VARIABLE_NAME por el nombre de una variable que deseas introducir en tu archivo de activadores.

    • VARIABLE_VALUE por el valor de la variable.

    • OVERRIDE_VARIABLE_NAME por el nombre de la variable de sustitución predeterminada de Secure Source Manager. Para obtener información sobre las variables de sustitución predeterminadas disponibles, consulta la sección de sustituciones del Esquema del archivo de activadores.

    • OVERRIDE_VARIABLE_VALUE por el valor con el que deseas anular el valor predeterminado de la variable de sustitución predeterminada.

  4. Confirma el archivo de configuración del activador en tu rama predeterminada.

    Una vez que se confirma el archivo de activadores, Secure Source Manager activa las compilaciones en función de la configuración de tu archivo de activadores.

    Secure Source Manager lee los archivos de configuración y la confirmación SHA o la referencia de Git asociadas de los siguientes tipos de eventos:

    • Para los eventos push, Secure Source Manager leerá la confirmación SHA o la referencia de Git cuando se complete el envío.
    • Para los eventos pull_request, Secure Source Manager leerá la confirmación SHA o la referencia de Git cuando se extraigan los cambios de la solicitud de extracción.

Ver el estado de la compilación

Cuando un evento de envío o solicitud de extracción activa una compilación, el estado de la confirmación y la compilación se muestra en la interfaz web de Secure Source Manager.

Los valores posibles para el estado de la compilación son los siguientes:

  • correctoSUCCESS: La compilación se completó correctamente.
  • advertenciaWARNING: Se produjo un problema cuando se intentó compilar.
  • fallaFAILURE: No se pudo realizar la compilación durante la ejecución.

Puedes evitar que las confirmaciones con compilaciones sin éxito se combinen en ramas importantes si configuras una regla de protección de ramas para requerir una verificación de estado exitosa de los activadores configurados en tu archivo de activadores. Para obtener más información sobre la protección de ramas, lee la Descripción general de la protección de ramas.

Para ver el estado de la compilación de un evento de envío, sigue estos pasos:

  1. En la interfaz web de Secure Source Manager, navega a tu repositorio.

    Si el evento de envío más reciente activó una compilación, el estado se muestra junto a la confirmación SHA. Para ver los detalles de ese estado, haz clic en el estado.

  2. Para ver el estado de la compilación de confirmaciones anteriores, selecciona Commits para ver el historial de confirmaciones y, luego, haz clic en el estado del que deseas ver los detalles.

Para ver el estado de la compilación de un evento de solicitud de extracción, sigue estos pasos:

  1. En la interfaz web de Secure Source Manager, haz clic en Pull requests.

  2. Haz clic en la solicitud de extracción que deseas ver.

    Si la solicitud de extracción activó compilaciones, verás una sección titulada either All checks were successful, or Some checks reported warnings.

¿Qué sigue?