GitHub Acción «Acciones» YAML - Amazon CodeCatalyst
nombre de la acciónIdentifierDependsOnComputeFleetTimeoutEnvironmentNameConnectionsNameRoleInputsSourcesArtifacts - inputVariables - inputOutputsArtifacts - outputNameFilesVariables - outputnombre de la variable-1AutoDiscoverReportsEnabledReportNamePrefixIncludePathsExcludePathsSuccessCriteriaPassRateLineCoverageBranchCoverageVulnerabilitiesReportsnombre-informe-1FormatConfigurationSteps

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

GitHub Acción «Acciones» YAML

La siguiente es la YAML definición de la acción GitHubAcciones.

Esta definición de acción existe como una sección dentro de un archivo de definición de flujo de trabajo más amplio. Para obtener más información acerca de este archivo, consulte YAMLDefinición del flujo de trabajo.

Elija una YAML propiedad en el código siguiente para ver una descripción de la misma.

nota

La mayoría de las YAML propiedades siguientes tienen los elementos de interfaz de usuario correspondientes en el editor visual. Para buscar un elemento de la interfaz de usuario, utilice Ctrl+F. El elemento aparecerá en la lista con su propiedad asociadaYAML.

# The workflow definition starts here.
# See Propiedades de nivel superior for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.
  action-name:
    Identifier:  aws/github-actions-runner@v1
    DependsOn:
      - dependent-action-name-1
    Compute:
      Fleet: fleet-name
    Timeout: timeout-minutes
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Inputs:
      Sources:
        - source-name-1
        - source-name-2
      Artifacts:
        - artifact-name
      Variables:
        - Name: variable-name-1
          Value: variable-value-1
        - Name: variable-name-2
          Value: variable-value-2   
    Outputs:
      Artifacts:
        - Name: output-artifact-1
          Files: 
            - github-output/artifact-1.jar
            - "github-output/build*"
        - Name: output-artifact-2
          Files:
            - github-output/artifact-2.1.jar
            - github-output/artifact-2.2.jar
      Variables:
        - variable-name-1
        - variable-name-2
      AutoDiscoverReports:
        Enabled: true | false
        ReportNamePrefix: AutoDiscovered
        IncludePaths:
          - "**/*"
        ExcludePaths:
          - node_modules/cdk/junit.xml
        SuccessCriteria:
          PassRate: percent
          LineCoverage: percent
          BranchCoverage: percent
          Vulnerabilities:
            Severity: CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL
            Number: whole-number
      Reports:
        report-name-1:
          Format: format
          IncludePaths:
            - "*.xml"
          ExcludePaths:
            - report2.xml
            - report3.xml
          SuccessCriteria:
            PassRate: percent
            LineCoverage: percent
            BranchCoverage: percent
            Vulnerabilities:
              Severity: CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL
              Number: whole-number
    Configuration      
      Steps:
        - github-actions-code

nombre de la acción

(Obligatorio)

Especifique el nombre de la acción. Todos los nombres de las acciones deben ser únicos en el flujo de trabajo. Los nombres de las acciones se limitan a caracteres alfanuméricos (a-z, A-Z, 0-9), guiones (-) y guiones bajos (_). No se permiten espacios. No se pueden usar comillas para habilitar los caracteres especiales y los espacios en los nombres de las acciones.

Interfaz de usuario correspondiente: pestaña de configuración/action-name

Identifier

(action-name/Identifier)

Identifica la acción. No cambie esta propiedad a menos que desee cambiar la versión. Para obtener más información, consulte Especificar la versión de la acción que se va a utilizar.

aws/github-actions-runner@v1Utilícela para GitHubacciones y acciones.

Interfaz de usuario correspondiente: diagrama de flujo de trabajo/action-nameEtiqueta/aws/ @v1 github-actions-runner

DependsOn

(action-name/DependsOn)

(Opcional)

Especifique una acción, un grupo de acciones o una puerta que debe ejecutarse correctamente para que esta acción se ejecute.

Para obtener más información sobre la funcionalidad «depende de», consulte. Secuenciación de acciones

Interfaz de usuario correspondiente: pestaña de entradas/Depende de (opcional)

Compute

(action-name/Compute)

(Opcional)

El motor informático utilizado para ejecutar las acciones del flujo de trabajo. Puede especificar el procesamiento en el nivel del flujo de trabajo o en el nivel de acción, pero no en ambos. Cuando se especifica en el nivel del flujo de trabajo, la configuración de procesamiento se aplica a todas las acciones definidas en el flujo de trabajo. En el nivel del flujo de trabajo, también puedes ejecutar varias acciones en la misma instancia. Para obtener más información, consulte Compartir el cómputo entre acciones.

Interfaz de usuario correspondiente: ninguna

Fleet

(action-name/Compute/Fleet)

(Opcional)

Especifique la máquina o la flota que ejecutará el flujo de trabajo o las acciones del flujo de trabajo. Con las flotas bajo demanda, cuando se inicia una acción, el flujo de trabajo aprovisiona los recursos que necesita y las máquinas se destruyen cuando finaliza la acción. Ejemplos de flotas bajo demanda:Linux.x86-64.Large,. Linux.x86-64.XLarge Para obtener más información sobre las flotas bajo demanda, consulte. Propiedades de la flota bajo demanda

Con las flotas aprovisionadas, puede configurar un conjunto de máquinas dedicadas para ejecutar las acciones de su flujo de trabajo. Estas máquinas permanecen inactivas y listas para procesar las acciones de forma inmediata. Para obtener más información sobre las flotas aprovisionadas, consulte. Propiedades de la flota aprovisionada

Si Fleet se omite, el valor predeterminado es. Linux.x86-64.Large

Interfaz de usuario correspondiente: pestaña de configuración/flota de cómputo (opcional)

Timeout

(action-name/Timeout)

(Opcional)

Especifique la cantidad de tiempo en minutos (YAMLeditor) o en horas y minutos (editor visual) que la acción puede ejecutarse antes de que CodeCatalyst finalice la acción. El mínimo es de 5 minutos y el máximo se describe enCuotas para flujos de trabajo en CodeCatalyst. El tiempo de espera predeterminado es el mismo que el tiempo de espera máximo.

Interfaz de usuario correspondiente: pestaña de configuración/tiempo de espera: opcional

Environment

(action-name/Environment)

(Opcional)

Especifique el CodeCatalyst entorno que se va a utilizar con la acción. La acción se conecta al Cuenta de AWS Amazon opcional VPC especificado en el entorno elegido. La acción usa el IAM rol predeterminado especificado en el entorno para conectarse a Amazon y usa el IAM rol especificado en la VPCconexión de Amazon para conectarse a AmazonVPC. Cuenta de AWS

nota

Si el IAM rol predeterminado no tiene los permisos necesarios para la acción, puedes configurar la acción para usar un rol diferente. Para obtener más información, consulte Cambiar el IAM papel de una acción.

Para obtener más información sobre los entornos, consulte Implementación en Cuentas de AWS y VPCs yCreación de un entorno.

Interfaz de usuario correspondiente: pestaña de configuración/entorno

Name

(action-name/Environment/Name)

(Obligatorio si Environment está incluido)

Especifique el nombre de un entorno existente que desee asociar a la acción.

Interfaz de usuario correspondiente: pestaña de configuración/entorno

Connections

(action-name/Environment/Connections)

(Opcional)

Especifique la conexión de cuenta que desee asociar a la acción. Puede especificar un máximo de una conexión de cuenta por debajoEnvironment.

Si no especificas una conexión de cuenta:

  • La acción utiliza la Cuenta de AWS conexión y el IAM rol predeterminado especificados en el entorno de la CodeCatalyst consola. Para obtener información sobre cómo añadir una conexión de cuenta y un IAM rol predeterminado al entorno, consulteCreación de un entorno.

  • El IAM rol predeterminado debe incluir las políticas y los permisos que requiere la acción. Para determinar cuáles son esas políticas y permisos, consulte la descripción de la propiedad del rol en la documentación de YAML definición de la acción.

Para obtener más información sobre las conexiones de cuentas, consultePermitir el acceso a AWS los recursos con conexión Cuentas de AWS. Para obtener información sobre cómo añadir una conexión de cuenta a un entorno, consulteCreación de un entorno.

Interfaz de usuario correspondiente: pestaña de configuración/Entorno/Contenido my-environment? /menú de tres puntos/ Cambiar rol

Name

(action-name/Environment/Connections/Name)

(Obligatorio si está incluidoConnections)

Especifique el nombre de la conexión de la cuenta.

Interfaz de usuario correspondiente: pestaña de configuración/Entorno/Contenido my-environment? /menú de tres puntos/ Cambiar rol

Role

(action-name/Environment/Connections/Role)

(Obligatorio si está incluidoConnections)

Especifique el nombre de la IAM función que utiliza esta acción para acceder y operar en AWS servicios como Amazon S3 y AmazonECR. Asegúrese de añadir este rol a la Cuenta de AWS conexión de su espacio. Para añadir un IAM rol a una conexión de cuenta, consulteAñadir IAM roles a las conexiones de cuentas.

Si no especifica ningún IAM rol, la acción utilizará el IAM rol predeterminado que aparece en el entorno de la CodeCatalyst consola. Si usa el rol predeterminado en el entorno, asegúrese de que tenga las siguientes políticas.

nota

Puede usar el CodeCatalystWorkflowDevelopmentRole-spaceName rol con esta acción. Para obtener más información acerca de este rol, consulte Crear el CodeCatalystWorkflowDevelopmentRole-spaceNamerol para su cuenta y su espacio. Ten en cuenta que el CodeCatalystWorkflowDevelopmentRole-spaceName rol tiene permisos de acceso total, lo que puede suponer un riesgo para la seguridad. Te recomendamos que solo utilices este rol en los tutoriales y en situaciones en las que la seguridad sea un problema menor.

aviso

Limite los permisos a los requeridos por la GitHub acción Action. El uso de un rol con permisos más amplios puede suponer un riesgo de seguridad.

Interfaz de usuario correspondiente: pestaña de configuración/Entorno/Contenido my-environment? /menú de tres puntos/ Cambiar rol

Inputs

(action-name/Inputs)

(Opcional)

La Inputs sección define los datos que necesita una acción durante la ejecución de un flujo de trabajo.

nota

Se permite un máximo de cuatro entradas (una fuente y tres artefactos) por acción de GitHub Actions. Las variables no se tienen en cuenta para este total.

Si necesita hacer referencia a archivos que se encuentran en entradas diferentes (por ejemplo, una fuente y un artefacto), la entrada de origen es la entrada principal y el artefacto es la entrada secundaria. Las referencias a los archivos en las entradas secundarias llevan un prefijo especial para distinguirlas de las principales. Para obtener más detalles, consulte Ejemplo: hacer referencia a archivos en varios artefactos.

Interfaz de usuario correspondiente: pestaña de entradas

Sources

(action-name/Inputs/Sources)

(Opcional)

Especifique las etiquetas que representan los repositorios de origen que necesitará la acción. Actualmente, la única etiqueta admitida es WorkflowSource la que representa el repositorio de origen en el que se almacena el archivo de definición de flujo de trabajo.

Si omite una fuente, debe especificar al menos un artefacto de entrada en ella. action-name/Inputs/Artifacts

Para obtener más información sobre orígenes, consulte Conexión de repositorios de origen a flujos de trabajo.

Interfaz de usuario correspondiente: pestaña Entradas/Fuentes: opcional

Artifacts - input

(action-name/Inputs/Artifacts)

(Opcional)

Especifique los artefactos de acciones anteriores que desee proporcionar como entrada a esta acción. Estos artefactos ya deben estar definidos como artefactos de salida en acciones anteriores.

Si no especifica ningún artefacto de entrada, debe especificar al menos un repositorio de origen en élaction-name/Inputs/Sources.

Para obtener más información sobre los artefactos, incluidos ejemplos, consulteCompartir artefactos y archivos entre acciones.

nota

Si la lista desplegable Artefactos (opcional) no está disponible (editor visual) o si se producen errores al validar el YAML archivo (YAMLeditor), es posible que la acción solo admita una entrada. En este caso, intenta eliminar la entrada de origen.

Interfaz de usuario correspondiente: pestaña de entradas/Artefactos (opcional)

Variables - input

(action-name/Inputs/Variables)

(Opcional)

Especifique una secuencia de pares de nombre/valor que definan las variables de entrada que desea poner a disposición de la acción. Los nombres de las variables se limitan a caracteres alfanuméricos (a-z, A-Z, 0-9), guiones (-) y guiones bajos (_). No se permiten espacios. No puede usar comillas para habilitar los caracteres especiales y los espacios en los nombres de las variables.

Para obtener más información sobre las variables, incluidos ejemplos, consulteUso de variables en los flujos de trabajo.

Interfaz de usuario correspondiente: pestaña de entradas/variables: opcional

Outputs

(action-name/Outputs)

(Opcional)

Define los datos que genera la acción durante la ejecución de un flujo de trabajo.

Interfaz de usuario correspondiente: pestaña de salidas

Artifacts - output

(action-name/Outputs/Artifacts)

(Opcional)

Especifique el nombre de un artefacto generado por la acción. Los nombres de los artefactos deben ser únicos dentro de un flujo de trabajo y están limitados a caracteres alfanuméricos (a-z, A-Z, 0-9) y guiones bajos (_). No se permiten espacios, guiones (-) ni otros caracteres especiales. No puede utilizar comillas para activar los espacios, guiones y otros caracteres especiales en los nombres de los artefactos de salida.

Para obtener más información sobre los artefactos, incluidos ejemplos, consulte. Compartir artefactos y archivos entre acciones

Interfaz de usuario correspondiente: pestaña de salidas/artefactos

Name

(action-name/Outputs/Artifacts/Name)

(Obligatorio si Artifacts - output está incluido)

Especifique el nombre de un artefacto generado por la acción. Los nombres de los artefactos deben ser únicos dentro de un flujo de trabajo y están limitados a caracteres alfanuméricos (a-z, A-Z, 0-9) y guiones bajos (_). No se permiten espacios, guiones (-) ni otros caracteres especiales. No puede utilizar comillas para activar los espacios, guiones y otros caracteres especiales en los nombres de los artefactos de salida.

Para obtener más información sobre los artefactos, incluidos ejemplos, consulte. Compartir artefactos y archivos entre acciones

Interfaz de usuario correspondiente: pestaña de salidas/Artifactos/Añadir artefacto/Construir nombre de artefacto

Files

(action-name/Outputs/Artifacts/Files)

(Artifacts - outputObligatorio si está incluido)

Especifique los archivos que se CodeCatalyst incluyen en el artefacto que se genera con la acción. Estos archivos los genera la acción del flujo de trabajo cuando se ejecuta y también están disponibles en el repositorio de origen. Las rutas de los archivos pueden residir en un repositorio de origen o en un artefacto de una acción anterior, y son relativas al repositorio de origen o a la raíz del artefacto. Puede utilizar patrones globales para especificar las rutas. Ejemplos:

  • Para especificar un único archivo que esté en la raíz de la ubicación de compilación o de la ubicación del repositorio de origen, utilice my-file.jar.

  • Para especificar un único archivo en un subdirectorio, use directory/my-file.jar o directory/subdirectory/my-file.jar.

  • Para especificar todos los archivos, utilice "**/*". El patrón glob de ** indica que debe coincidir con cualquier número de subdirectorios.

  • Para especificar todos los archivos y directorios de un directorio denominado directory, utilice "directory/**/*". El patrón glob de ** indica que debe coincidir con cualquier número de subdirectorios.

  • Para especificar todos los archivos de un directorio denominado directory, pero no ninguno de sus subdirectorios, utilice "directory/*".

nota

Si la ruta del archivo incluye uno o más asteriscos (*) u otro carácter especial, escriba la ruta entre comillas dobles (). "" Para obtener más información sobre los caracteres especiales, consulte. Pautas y convenciones de sintaxis

Para obtener más información sobre los artefactos, incluidos ejemplos, consulteCompartir artefactos y archivos entre acciones.

nota

Puede que tenga que añadir un prefijo a la ruta del archivo para indicar en qué artefacto o fuente puede encontrarlo. Para obtener más información, consulte Hacer referencia a los archivos del repositorio de origen y Hacer referencia a archivos en un artefacto.

Interfaz de usuario correspondiente: pestaña de salidas/Artifactos/Agregar artefacto/Archivos producidos por build

Variables - output

(action-name/Outputs/Variables)

(Opcional)

Especifique las variables que desea que exporte la acción para que estén disponibles para su uso en acciones posteriores.

Para obtener más información sobre las variables, incluidos ejemplos, consulteUso de variables en los flujos de trabajo.

Interfaz de usuario correspondiente: pestaña de salidas/Variables/ Añadir variable

nombre de la variable-1

(action-name/Outputs/Variablesnombre-variable (1)

(Opcional)

Especifique el nombre de la variable que desee que exporte la acción. Esta variable ya debe estar definida en la Steps sección Inputs o de la misma acción.

Para obtener más información sobre las variables, incluidos ejemplos, consulteUso de variables en los flujos de trabajo.

Interfaz de usuario correspondiente: pestaña de salidas/Variables/Añadir variable/ Nombre

AutoDiscoverReports

(action-name/Outputs/AutoDiscoverReports)

(Opcional)

Define la configuración de la función de detección automática.

Al habilitar la detección automática, CodeCatalyst busca todos los archivos Inputs transferidos a la acción, así como todos los archivos generados por la propia acción, buscando informes de pruebas, cobertura de código y análisis de composición de software (SCA). Para cada informe que se encuentre, lo CodeCatalyst transforma en un CodeCatalyst informe. Un CodeCatalyst informe es un informe que está totalmente integrado en el CodeCatalyst servicio y se puede ver y manipular a través de la CodeCatalyst consola.

nota

De forma predeterminada, la función de detección automática inspecciona todos los archivos. Puede limitar los archivos que se inspeccionan mediante las propiedades IncludePaths oExcludePaths.

Interfaz de usuario correspondiente: ninguna

Enabled

(action-name/Outputs/AutoDiscoverReports/Enabled)

(Opcional)

Activa o desactiva la función de detección automática.

Los valores válidos son true o false.

Si Enabled se omite, el valor predeterminado es. true

Interfaz de usuario correspondiente: pestaña de salidas/Informes/Detección automática de informes

ReportNamePrefix

(action-name/Outputs/AutoDiscoverReports/ReportNamePrefix)

(Obligatorio si AutoDiscoverReports está incluido y activado)

Especifique un prefijo que CodeCatalyst preceda a todos los informes que encuentre para asignar un nombre a los informes asociados. CodeCatalyst Por ejemplo, si especifica un prefijo de AutoDiscovered y CodeCatalyst descubre automáticamente dos informes de pruebas TestSuiteOne.xml yTestSuiteTwo.xml, los CodeCatalyst informes asociados se AutoDiscoveredTestSuiteOne denominarán y. AutoDiscoveredTestSuiteTwo

Interfaz de usuario correspondiente: pestaña de salidas/Informes/Detección automática de informes/Prefijo de informe

IncludePaths

(action-name/Outputs/AutoDiscoverReports/IncludePaths)

Or (Disyunción)

(action-name/Outputs/Reports/report-name-1/IncludePaths)

(Obligatorio si AutoDiscoverReports está incluido y activado, o si está incluido) Reports

Especifique los archivos y las rutas de archivo que se CodeCatalyst incluyen al buscar informes sin procesar. Por ejemplo, si lo especificas"/test/report/*", CodeCatalyst busca en el /test/report/* directorio toda la imagen de compilación utilizada por la acción. Cuando encuentra ese directorio, CodeCatalyst busca los informes en ese directorio.

nota

Si la ruta del archivo incluye uno o más asteriscos (*) u otros caracteres especiales, escriba la ruta entre comillas dobles (). "" Para obtener más información sobre los caracteres especiales, consulte. Pautas y convenciones de sintaxis

Si se omite esta propiedad, será la predeterminada"**/*", lo que significa que la búsqueda incluirá todos los archivos de todas las rutas.

nota

En el caso de los informes configurados manualmente, IncludePaths debe ser un patrón global que coincida con un único archivo.

Interfaz de usuario correspondiente:

  • Pestaña de salidas/Informes/Detección automática de informes/'Incluir/Excluir rutas'/Incluir rutas

  • Pestaña de salidas/Informes/Configurar informes manualmente/report-name-1/'Incluir/excluir rutas'/ Incluir rutas

ExcludePaths

(action-name/Outputs/AutoDiscoverReports/ExcludePaths)

Or (Disyunción)

(action-name/Outputs/Reports/report-name-1/ExcludePaths)

(Opcional)

Especifique los archivos y las rutas de archivo que se CodeCatalyst excluyen al buscar informes sin procesar. Por ejemplo, si lo especifica"/test/my-reports/**/*", no CodeCatalyst buscará archivos en el /test/my-reports/ directorio. Para ignorar todos los archivos de un directorio, utilice el patrón **/* global.

nota

Si la ruta del archivo incluye uno o más asteriscos (*) u otros caracteres especiales, escriba la ruta entre comillas dobles (). "" Para obtener más información sobre los caracteres especiales, consulte. Pautas y convenciones de sintaxis

Interfaz de usuario correspondiente:

  • Pestaña de salidas/Informes/Detección automática de informes/'Incluir/Excluir rutas'/Excluir rutas

  • Pestaña de salidas/Informes/Configurar informes manualmente/report-name-1/'Incluir/excluir rutas'/ Excluir rutas

SuccessCriteria

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria)

Or (Disyunción)

(action-name/Outputs/Reports/report-name-1/SuccessCriteria)

(Opcional)

Especifique los criterios de éxito de los informes de prueba, cobertura del código, análisis de composición del software (SCA) y análisis estático (SA).

Para obtener más información, consulte Configurar los criterios de éxito de los informes.

Interfaz de usuario correspondiente:

  • Pestaña de salidas/Informes/Detección automática de informes/Criterios de éxito

  • Pestaña de salidas/Informes/Configurar informes manualmente/report-name-1/Criterios de éxito

PassRate

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/PassRate)

Or (Disyunción)

(action-name/Outputs/Reports/report-name-1/SuccessCriteria/PassRate)

(Opcional)

Especifique el porcentaje de pruebas en un informe de prueba que deben aprobarse para que el CodeCatalyst informe asociado se marque como aprobado. Los valores válidos incluyen los números decimales. Por ejemplo: 50, 60.5. Los criterios de porcentaje de aprobados se aplican únicamente a los informes de las pruebas. Para obtener más información sobre los informes de las pruebas, consulteInformes de pruebas.

Interfaz de usuario correspondiente:

  • Pestaña de salidas/Informes/Detección automática de informes/Criterios de éxito/Tasa de aprobación

  • Pestaña de salidas/Informes/Configurar informes manualmente/report-name-1/Criterios de éxito/ Tasa de aprobación

LineCoverage

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/LineCoverage)

Or (Disyunción)

(action-name/Outputs/Reports/report-name-1/SuccessCriteria/LineCoverage)

(Opcional)

Especifique el porcentaje de líneas de un informe de cobertura de código que deben cubrirse para que el CodeCatalyst informe asociado se marque como aprobado. Los valores válidos incluyen los números decimales. Por ejemplo: 50, 60.5. Los criterios de cobertura de línea se aplican únicamente a los informes de cobertura de código. Para obtener más información sobre los informes de cobertura de código, consulteInformes de cobertura de código.

Interfaz de usuario correspondiente:

  • Pestaña de salidas/Informes/Detección automática de informes/Criterios de éxito/Cobertura de línea

  • Pestaña de salidas/Informes/Configurar informes manualmente/report-name-1/Criterios de éxito/ Cobertura de línea

BranchCoverage

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/BranchCoverage)

Or (Disyunción)

(action-name/Outputs/Reports/report-name-1/SuccessCriteria/BranchCoverage)

(Opcional)

Especifique el porcentaje de ramas de un informe de cobertura de código que deben cubrirse para que el CodeCatalyst informe asociado se marque como aprobado. Los valores válidos incluyen los números decimales. Por ejemplo: 50, 60.5. Los criterios de cobertura de las sucursales se aplican únicamente a los informes de cobertura de códigos. Para obtener más información sobre los informes de cobertura de código, consulteInformes de cobertura de código.

Interfaz de usuario correspondiente:

  • Pestaña de salidas/Informes/Detección automática de informes/Criterios de éxito/Cobertura de sucursales

  • Pestaña de salidas/Informes/Configurar informes manualmente/report-name-1/Criterios de éxito/ Cobertura de sucursales

Vulnerabilities

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/Vulnerabilities)

Or (Disyunción)

(action-name/Outputs/Reports/report-name-1/SuccessCriteria/Vulnerabilities)

(Opcional)

Especifique el número máximo y la gravedad de las vulnerabilidades permitidas en el SCA informe para que el CodeCatalyst informe asociado se marque como aprobado. Para especificar las vulnerabilidades, debe especificar:

  • La gravedad mínima de las vulnerabilidades que desea incluir en el recuento. Los valores válidos, del más grave al menos grave, son:CRITICAL,HIGH,MEDIUM,LOW,INFORMATIONAL.

    Por ejemplo, si lo eligeHIGH, se HIGH contabilizarán CRITICAL las vulnerabilidades.

  • El número máximo de vulnerabilidades de la gravedad especificada que desea permitir. Si se supera este número, el CodeCatalyst informe se marca como fallido. Los valores válidos son números enteros.

Los criterios de vulnerabilidad se aplican únicamente a SCA los informes. Para obtener más información sobre SCA los informes, consulteInformes de análisis de composición de software.

Para especificar la gravedad mínima, utilice la Severity propiedad. Para especificar el número máximo de vulnerabilidades, utilice la Number propiedad.

Para obtener más información sobre SCA los informes, consulteTipos de informes de calidad.

Interfaz de usuario correspondiente:

  • Pestaña de salidas/Informes/Detección automática de informes/Criterios de éxito/Vulnerabilidades

  • Pestaña de salidas/Informes/Configurar informes manualmente/report-name-1/Criterios de éxito/ Vulnerabilidades

Reports

(action-name/Outputs/Reports )

(Opcional)

Una sección que especifica la configuración de los informes de pruebas.

Interfaz de usuario correspondiente: pestaña de salidas/informes

nombre-informe-1

(action-name/Outputs/Reports/nombre-informe-1)

(Obligatorio si está incluido) Reports

El nombre que desea asignar al CodeCatalyst informe que se generará a partir de los informes sin procesar.

Interfaz de usuario correspondiente: pestaña de salidas/informes/configuración manual/nombre del informe

Format

(action-name/Outputs/Reports/report-name-1/Format)

(Obligatorio si está incluido) Reports

Especifique el formato de archivo que va a utilizar para sus informes. Los valores posibles son los siguientes.

  • Para los informes de prueba:

    • Para CucumberJSON, especifique Cucumber (editor visual) o CUCUMBERJSON (YAMLeditor).

    • Para JUnitXML, especifique JUnit(editor visual) o JUNITXML (YAMLeditor).

    • Para NUnitXML, especifique NUnit(editor visual) o NUNITXML (YAMLeditor).

    • Para NUnit 3XML, especifique NUnit3(editor visual) o NUNIT3XML (YAMLeditor).

    • En Visual StudioTRX, especifique Visual Studio TRX (editor visual) o VISUALSTUDIOTRX (YAMLeditor).

    • Para TestNGXML, especifique TestNG (editor visual) o TESTNGXML (editor). YAML

  • Para los informes de cobertura de código:

    • Para CloverXML, especifique Clover (editor visual) o CLOVERXML (YAMLeditor).

    • XMLEn Cobertura, especifique Cobertura (editor visual) o COBERTURAXML (YAMLeditor).

    • Para JaCoCo XML, especifique JaCoCo(editor visual) o JACOCOXML (YAMLeditor).

    • Para SimpleCov JSON generado por simplecov, no por simplecov-json, especifique Simplecov (editor visual) o (editor). SIMPLECOV YAML

  • Para los informes SCA de análisis de composición de software ():

    • ParaSARIF, especifique SARIF(editor visual) o SARIFSCA (YAMLeditor).

Interfaz de usuario correspondiente: pestaña de salidas/Informes/Configurar informes/Agregar informe/report-name-1/Tipo de informe y formato de informe

Configuration

(action-name/Configuration)

(Obligatorio) Una sección en la que puede definir las propiedades de configuración de la acción.

Interfaz de usuario correspondiente: pestaña de configuración

Steps

(action-name/Configuration/Steps)

(Obligatorio)

Especifica tu código de GitHub acción tal como aparece en la página de detalles de la acción en GitHub Marketplace. Agrega el código siguiendo estas pautas:

  1. Pegue el código de la steps: sección de la GitHub acción en la Steps: sección del CodeCatalyst flujo de trabajo. El código comienza con un guión (-) y tiene un aspecto similar al siguiente.

    GitHub código para pegar:

    - name: Lint Code Base
  uses: github/super-linter@v4
  env:
    VALIDATE_ALL_CODEBASE: false
    DEFAULT_BRANCH: master
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  2. Revise el código que acaba de pegar y modifíquelo según sea necesario para que cumpla con los CodeCatalyst estándares. Por ejemplo, con el bloque de código anterior, puede eliminar el código de red italicsy añadir el código en negrita.

    CodeCatalyst flujo de trabajo yaml:

    Steps:      
   - name: Lint Code Base
     uses: github/super-linter@v4
     env:
       VALIDATE_ALL_CODEBASE: false
       DEFAULT_BRANCH: mastermain
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  3. Para obtener código adicional que se incluye en la GitHub acción pero que no existe dentro de la steps: sección, agréguelo al CodeCatalyst flujo de trabajo con un código CodeCatalyst equivalente. Puedes revisarla YAMLDefinición del flujo de trabajo para obtener información sobre cómo puedes transferir tu GitHub código a CodeCatalyst. Los pasos de migración detallados están fuera del alcance de esta guía.

A continuación, se muestra un ejemplo de cómo especificar las rutas de los archivos en una acción de GitHub Actions:

Steps:
  - name: Lint Code Base
    uses: github/super-linter@v4
    ...
  - run: cd /sources/WorkflowSource/MyFolder/  && cat file.txt
  - run: cd /artifacts/MyGitHubAction/MyArtifact/MyFolder/  && cat file2.txt

Para obtener más información sobre cómo especificar las rutas de los archivos, consulte Hacer referencia a los archivos del repositorio de origen yHacer referencia a archivos en un artefacto.

Interfaz de usuario correspondiente: pestaña de configuración/acciones GitHub YAML