Adición de una acción de GitHub seleccionada - Amazon CodeCatalyst

Amazon CodeCatalyst ya no está disponible para nuevos clientes. Los clientes existentes pueden seguir utilizando el servicio con normalidad. Para obtener más información, consulte Cómo migrar de CodeCatalyst.

Adición de una acción de GitHub seleccionada

Una acción de GitHub seleccionada es una acción de GitHub que está disponible en la consola de CodeCatalyst y sirve como ejemplo de cómo usar una acción de GitHub dentro de un flujo de trabajo de CodeCatalyst.

Las acciones de GitHub seleccionadas están incluidas en la acción de GitHub Actions, creada por CodeCatalyst e identificada por el identificador aws/github-actions-runner@v1. Por ejemplo, este es el aspecto de la acción de GitHub seleccionada TruffleHog OSS: 

Actions:
  TruffleHogOSS_e8:
    Identifier: aws/github-actions-runner@v1
    Inputs:
      Sources:
        - WorkflowSource # This specifies that the action requires this Workflow as a source
    Configuration:
      Steps:
        - uses: trufflesecurity/trufflehog@v3.16.0
          with:
            path: ' ' # Required; description: Repository path
            base: ' ' # Required; description: Start scanning from here (usually main branch).
            head: ' ' # Optional; description: Scan commits until here (usually dev branch).
            extra_args: ' ' # Optional; description: Extra args to be passed to the trufflehog cli.

En el código anterior, la acción de GitHub Actions de CodeCatalyst (identificada por aws/github-actions-runner@v1) envuelve la acción TruffleHog OSS (identificada por trufflesecurity/trufflehog@v3.16.0), lo que hace que funcione en un flujo de trabajo de CodeCatalyst.

Para configurar esta acción, debe reemplazar las cadenas vacías bajo with: con sus propios valores. Por ejemplo:

Actions:
  TruffleHogOSS_e8:
    Identifier: aws/github-actions-runner@v1
    Inputs:
      Sources:
        - WorkflowSource # This specifies that the action requires this Workflow as a source
    Configuration:
      Steps:
        - uses: trufflesecurity/trufflehog@v3.16.0
          with:
            path: ./
            base: main # Required; description: Start scanning from here (usually main branch).
            head: HEAD # Optional; description: Scan commits until here (usually dev branch).
            extra_args: '‐‐debug ‐‐only-verified' # Optional; description: Extra args to be passed to the trufflehog cli.

Para añadir una acción de GitHub seleccionada a un flujo de trabajo, use el siguiente procedimiento. Para obtener información general sobre cómo utilizar GitHub Actions dentro de un flujo de trabajo de CodeCatalyst, consulte Integración con GitHub Actions.

nota

Si no ve su acción de GitHub en la lista de acciones seleccionadas, puede añadirla al flujo de trabajo mediante la acción de GitHub Actions. Para obtener más información, consulte Adicción de la acción de GitHub Actions.

Visual
Adición de una acción de GitHub seleccionada mediante el editor visual

  1. Abra la consola de CodeCatalyst en https://codecatalyst.aws/.

  2. Elija el proyecto.

  3. En el panel de navegación, elija CI/CD y, a continuación, elija Flujos de trabajo.

  4. Elija el nombre del flujo de trabajo. Puede filtrar por el nombre del repositorio de código fuente o la ramificación donde esté definido el flujo de trabajo, o bien por el nombre o el estado del flujo de trabajo.

  5. Elija Editar.

  6. Elija Visual.

  7. En la parte superior izquierda, seleccione + Acciones para abrir el catálogo de acciones.

  8. En la lista desplegable, seleccione GitHub.

  9. Navegue hasta encontrar una acción de GitHub y haga lo siguiente:

    • Elija el signo más (+) para añadir la acción al diagrama de flujo de trabajo y abrir su panel de configuración.

      O

    • Elija el nombre de la acción de GitHub. Aparecerá el cuadro de diálogo de detalles de la acción. En este cuadro de diálogo:

      • (Opcional) Seleccione Ver código fuente para ver el código fuente de la acción.

      • Seleccione Añadir al flujo de trabajo para añadir la acción al diagrama de flujo de trabajo y abrir su panel de configuración.

  10. En las pestañas Entradas, Configuración y Salidas, complete los campos según sus necesidades. Para obtener una descripción de cada uno de los campos, consulte la YAML de la acción de GitHub Actions. Esta referencia proporciona información detallada sobre cada campo (y el valor de propiedad de YAML correspondiente) disponible para la acción de GitHub Actions, tal y como aparece en el editor visual y el de YAML.

    Para obtener información sobre las opciones de configuración disponibles para la acción de GitHub seleccionada, consulte la documentación.

  11. (Opcional) Seleccione Validar para validar el código de YAML del flujo de trabajo antes de confirmarlo.

  12. Seleccione Confirmar, introduzca un mensaje de confirmación y vuelva a seleccionar Confirmar.

YAML
Adición de una acción de GitHub seleccionada mediante el editor de YAML

  1. Abra la consola de CodeCatalyst en https://codecatalyst.aws/.

  2. Elija el proyecto.

  3. En el panel de navegación, elija CI/CD y, a continuación, elija Flujos de trabajo.

  4. Elija el nombre del flujo de trabajo. Puede filtrar por el nombre del repositorio de código fuente o la ramificación donde esté definido el flujo de trabajo, o bien por el nombre o el estado del flujo de trabajo.

  5. Seleccione Editar.

  6. Elija YAML.

  7. En la parte superior izquierda, seleccione + Acciones para abrir el catálogo de acciones.

  8. En la lista desplegable, seleccione GitHub.

  9. Navegue hasta encontrar una acción de GitHub y haga lo siguiente:

    • Elija el signo más (+) para añadir la acción al diagrama de flujo de trabajo y abrir su panel de configuración.

      O

    • Elija el nombre de la acción de GitHub. Aparecerá el cuadro de diálogo de detalles de la acción. En este cuadro de diálogo:

      • (Opcional) Seleccione Ver código fuente para ver el código fuente de la acción.

      • Seleccione Añadir al flujo de trabajo para añadir la acción al diagrama de flujo de trabajo y abrir su panel de configuración.

  10. Modifique las propiedades del código de YAML en función de sus necesidades. Se proporciona una explicación de todas las propiedades disponibles para la acción de GitHub Actions en la YAML de la acción de GitHub Actions.

    Para obtener información sobre las opciones de configuración disponibles para la acción de GitHub seleccionada, consulte la documentación.

  11. (Opcional) Seleccione Validar para validar el código de YAML del flujo de trabajo antes de confirmarlo.

  12. Seleccione Confirmar, introduzca un mensaje de confirmación y vuelva a seleccionar Confirmar.