Como desarrollador o administrador de Code Stream, puede utilizar el activador de Gerrit para integrar los servicios de nube de Code Stream con el ciclo de vida de revisión de código de Gerrit. El evento acciona una canalización para que se ejecute al crear un conjunto de revisiones, publicar borradores, combinar cambios de código en el proyecto de Gerrit o insertar cambios directamente en la rama de Git.

Al agregar el activador para Gerrit, seleccionará un agente de escucha de Gerrit y un proyecto de Gerrit en el servidor, y configurará los eventos de Gerrit. En este ejemplo, se configura un agente de escucha de Gerrit en primer lugar y, a continuación, se utiliza ese agente en un activador de Gerrit con dos eventos en tres canalizaciones diferentes.

Requisitos previos

Procedimiento

  1. En Code Stream, haga clic en Activadores > Gerrit.
  2. (opcional) Haga clic en la pestaña Agentes de escucha y, a continuación, haga clic en Nuevo agente de escucha.
    Nota: Omita este paso si el agente de escucha de Gerrit que tiene pensado usar para el activador de Gerrit ya está definido.
    1. Seleccione un proyecto.
    2. Introduzca un nombre para el agente de escucha de Gerrit.
    3. Seleccione un endpoint de Gerrit.
    4. Introduzca el token de API.
      El token de API de CSP lo autentica para las conexiones de API externas con Code Stream. Para obtener el token de API:
      1. Inicie sesión en vRealize Automation Cloud.
      2. Haga clic en la flecha del menú desplegable que aparece junto a su nombre.
      3. Haga clic en Mi cuenta.
      4. Haga clic en Tokens de API.
      5. Haga clic en Generar token.
        1. Introduzca un nombre de token.
        2. En Funciones de organización, seleccione Propietario de la organización.
        3. En Funciones de servicio, haga clic para expandir VMware Code Stream y seleccione Administrador de Code Stream.
        4. Haga clic en Generar.

          La ventana Token generado muestra un token con el nombre que especificó y el nombre de la organización.

      6. Haga clic en el icono COPIAR.

        Si hace clic en COPIAR, se asegura de que se captura la cadena exacta, lo cual resulta más confiable que utilizar el puntero para copiar la cadena.

      Si creó una variable, el token de API muestra el nombre de la variable que introdujo. Si ha copiado el token, el token de API muestra el token enmascarado.

      Agente de escucha de Gerrit para SaaS del activador

    5. Para validar los detalles del endpoint y el token, haga clic en Validar.
      El token caduca tras 90 días.
    6. Haga clic en Crear.
    7. En la tarjeta del agente de escucha, haga clic en Conectar.
      El agente de escucha inicia la supervisión de toda la actividad en el servidor de Gerrit y escucha los activadores habilitados en ese servidor. Para dejar de escuchar un activador en ese servidor, deshabilite el activador.
  3. Haga clic en la pestaña Activadores y, a continuación, haga clic en Nuevo activador de Gerrit.
  4. Seleccione un proyecto del servidor de Gerrit.
  5. Introduzca un nombre.
    El nombre del activador de Gerrit debe ser exclusivo.
  6. Seleccione un agente de escucha de Gerrit configurado.
    Code Stream utiliza la selección de agente de escucha de Gerrit para proporcionar una lista de proyectos de Gerrit que están disponibles en el servidor.
  7. Seleccione un proyecto del servidor de Gerrit.
  8. Introduzca la rama en el repositorio que se va a supervisar.
  9. (opcional) Proporcione inclusiones o exclusiones de archivos como condiciones para el activador.
    • Proporcione inclusiones de archivos para que se activen las canalizaciones. Cuando cualquiera de los archivos de una confirmación coincida con los archivos especificados en las rutas de inclusión o las expresiones regulares, se activarán las canalizaciones. Con una expresión regular especificada, Code Stream solo activa canalizaciones con nombres de archivo en el conjunto de cambios que coinciden con la expresión proporcionada. El filtro de expresiones regulares es útil cuando se configura un activador para varias canalizaciones en un solo repositorio.
    • Proporcione exclusiones de archivos para impedir que se activen las canalizaciones. Cuando todos los archivos de una confirmación coinciden con los archivos especificados en las rutas de exclusión o en las expresiones regulares, no se activarán las canalizaciones.
    • Al activar Priorizar exclusión, garantiza que no se activan las canalizaciones. Las canalizaciones no se activarán aunque alguno de los archivos de una confirmación coincida con los archivos especificados en las rutas de exclusión o en las expresiones regulares. De forma predeterminada, esta opción está desactivada.
    Si se cumplen tanto las condiciones de inclusión como las de exclusión, no se activan las canalizaciones.

    En el siguiente ejemplo, tanto las inclusiones como las exclusiones de archivos son condiciones para el activador.

    Ejemplo de inclusiones y exclusiones de archivos

    • Para las inclusiones de archivos, una confirmación con cualquier cambio en runtime/src/main/a.java o cualquier archivo Java activará las canalizaciones configuradas en la configuración de eventos.
    • Para las exclusiones de archivos, una confirmación con cambios solo en ambos archivos no activará las canalizaciones configuradas en las configuraciones de eventos.
  10. Haga clic en Nueva configuración.
    1. Para un evento de Gerrit, seleccione Conjunto de revisiones creado, Borrador publicado o Cambio combinado. O bien, para una inserción directa en Git que omita Gerrit, seleccione Inserción de Git directa.
    2. Seleccione la canalización que desea activar.
      Si la canalización se configuró con parámetros de entrada personalizados agregados, la lista Parámetros de entrada muestra parámetros y valores. Puede introducir valores para los parámetros de entrada que se transferirán a la canalización con el evento activador. Opcionalmente, puede dejar los valores en blanco o utilizar los valores predeterminados.
      Nota: Si se van a definir valores predeterminados:
      • Cualquier valor que introduzca para los parámetros de entrada sobrescribirán los valores predeterminados que se hayan definido en el modelo de canalización.
      • Los valores predeterminados que se utilicen para configurar el activador no se actualizarán si se cambian los valores de los parámetros en el modelo de canalización.

      Para obtener información sobre los parámetros de entrada de inserción automática de los activadores de Gerrit, consulte Requisitos previos.

    3. Para las opciones Conjunto de revisiones creado, Borrador publicado y Cambio combinado, algunas acciones aparecen con etiquetas de forma predeterminada. Puede cambiar la etiqueta o añadir comentarios. A continuación, cuando se ejecuta la canalización, la etiqueta o el comentario aparecen en la pestaña Actividad como la Acción realizada para la canalización.
    4. Haga clic en Guardar.
    Para agregar varios eventos de activador en diversas canalizaciones, vuelva a hacer clic en Nueva configuración.
    En el siguiente ejemplo, puede ver eventos de tres canalizaciones:
    • Si se produce un evento de Cambio combinado en el proyecto de Gerrit, se activará la canalización Gerrit-Pipeline.
    • Si se produce un evento de Conjunto de revisiones creado en el proyecto de Gerrit, se activarán las canalizaciones Gerrit-Trigger-Pipeline y Gerrit-Demo-Pipeline.

    Configuración del agente de escucha y el activador de Gerrit

  11. Haga clic en Crear.
    El activador aparece como una tarjeta nueva y está inhabilitado de forma predeterminada.
  12. En la tarjeta del activador, haga clic en Habilitar.
    Cuando el activador está habilitado, utiliza el agente de escucha de Gerrit para empezar a supervisar los eventos que se producen en la rama del proyecto de Gerrit.
    Cuando se crea el activador, se incluye el repositorio donde se confirma el código. Si desea crear un activador con las mismas condiciones de inclusión o exclusión del archivo, pero con otro repositorio, puede hacer clic en Acciones > Clonar en la tarjeta del activador. A continuación, haga clic en Abrir en el nuevo activador y cambie los parámetros.

Resultados

Enhorabuena. Configuró correctamente un activador de Gerrit con dos eventos en tres canalizaciones diferentes.

Qué hacer a continuación

Después de confirmar un cambio de código en el proyecto de Gerrit, consulte la pestaña Actividad del evento de Gerrit en Code Stream. Compruebe que la lista de actividades incluya las entradas correspondientes a cada ejecución de la canalización configurada en el activador. Cuando se produzca un evento, solo se ejecutarán las canalizaciones del activador de Gerrit que estén relacionadas con el tipo de evento en cuestión. En este ejemplo, si se crea un conjunto de revisiones, solo se ejecutarán las canalizaciones Gerrit-Trigger-Pipeline y Gerrit-Demo-Pipeline.

La información de las columnas de la pestaña Actividad describe cada evento del activador de Gerrit. Puede elegir las columnas que se van a mostrar.
  • Si el activador era una inserción de Git directa, las columnas Cambiar asunto y Ejecución están vacías.
  • La columna Activador de Gerrit muestra el activador que creó el evento.
  • El agente de escucha está desactivado de forma predeterminada. Si se selecciona, se muestra el agente de escucha de Gerrit que recibió el evento. Un agente de escucha puede asociarse con varios activadores.
  • La opción Tipo de activador está desactivada de forma predeterminada. Al seleccionarla, muestra si el activador se activó de forma manual o automática.

Actividad del activador de Gerrit

Para controlar la actividad de una ejecución completada o con errores, haga clic en los tres puntos situados a la izquierda de cualquier entrada de la pantalla Actividad.
  • Si la canalización no se ejecuta debido a un error en el modelo de canalización u otro problema, corrija el error y seleccione Volver a ejecutar para volver a ejecutarla.
  • Si la canalización no se ejecuta debido a un problema de conectividad de red o de otro tipo, seleccione Reanudar para reiniciar la misma ejecución de la canalización. Si lo hace de esta manera, ahorrará tiempo de ejecución.
  • Utilice Ver ejecución para ir a la pantalla Ejecución. Consulte Cómo ejecutar una canalización y ver los resultados.
  • Utilice Eliminar para eliminar la entrada de la pantalla Actividad.
Si un evento de Gerrit no activa una canalización, puede hacer clic en el botón Activar manualmente, e introducir el nombre del activador de Gerrit y el identificador de cambio.

Es posible que se haya omitido un evento de Gerrit debido a una pérdida de conexión entre el servidor de Gerrit y el proxy de nube de la canalización. La pérdida de conexión puede durar hasta 10 minutos. La pérdida de conexión se puede producir si se actualiza o se reinicia el servidor de Gerrit. También puede ocurrir si se actualiza el proxy de nube de la canalización.