« GitHub Actions » action YAML

Voici la YAML définition de l'action GitHubActions.

Cette définition d'action existe sous la forme d'une section au sein d'un fichier de définition de flux de travail plus large. Pour de plus amples informations sur ce fichier, veuillez consulter YAMLDéfinition du flux de travail.

Choisissez une YAML propriété dans le code suivant pour en voir la description.

Note

La plupart des YAML propriétés ci-dessous ont des éléments d'interface utilisateur correspondants dans l'éditeur visuel. Pour rechercher un élément de l'interface utilisateur, utilisez Ctrl+F. L'élément sera répertorié avec sa YAML propriété associée.


# The workflow definition starts here.
# See Propriétés de haut niveau 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

nom-action

(Obligatoire)

Spécifiez le nom de l'action. Tous les noms d'action doivent être uniques dans le flux de travail. Les noms d'action sont limités aux caractères alphanumériques (a-z, A-Z, 0-9), aux tirets (-) et aux traits de soulignement (_). Les espaces ne sont pas autorisés. Vous ne pouvez pas utiliser de guillemets pour activer les caractères spéciaux et les espaces dans les noms d'action.

Interface utilisateur correspondante : onglet Configuration/action-name

Identifier

(action-name/Identifier)

Identifie l'action. Ne modifiez pas cette propriété, sauf si vous souhaitez modifier la version. Pour plus d’informations, consultez Spécification de la version de l'action à utiliser.

À utiliser aws/github-actions-runner@v1 pour GitHubles actions Actions.

Interface utilisateur correspondante : diagramme de flux de travail/action-nameétiquette/aws/ github-actions-runner @v1

DependsOn

(action-name/DependsOn)

(Facultatif)

Spécifiez une action, un groupe d'actions ou une porte qui doit s'exécuter correctement pour que cette action soit exécutée.

Pour plus d'informations sur la fonctionnalité « dépend », consultez. Actions de séquençage

Interface utilisateur correspondante : onglet Entrées/dépend de - facultatif

Compute

(action-name/Compute)

(Facultatif)

Le moteur informatique utilisé pour exécuter les actions de votre flux de travail. Vous pouvez spécifier le calcul au niveau du flux de travail ou au niveau de l'action, mais pas les deux. Lorsqu'elle est spécifiée au niveau du flux de travail, la configuration de calcul s'applique à toutes les actions définies dans le flux de travail. Au niveau du flux de travail, vous pouvez également exécuter plusieurs actions sur la même instance. Pour plus d’informations, consultez Partage du calcul entre les actions.

Interface utilisateur correspondante : aucune

Fleet

(action-name/Compute/Fleet)

(Facultatif)

Spécifiez la machine ou le parc qui exécutera votre flux de travail ou vos actions de flux de travail. Dans le cas des flottes à la demande, lorsqu'une action démarre, le flux de travail fournit les ressources dont il a besoin et les machines sont détruites à la fin de l'action. Exemples de flottes à la demande :Linux.x86-64.Large,Linux.x86-64.XLarge. Pour plus d'informations sur les flottes à la demande, consultezPropriétés de flotte à la demande.

Avec les flottes provisionnées, vous configurez un ensemble de machines dédiées pour exécuter les actions de votre flux de travail. Ces machines restent inactives, prêtes à exécuter des actions immédiatement. Pour plus d'informations sur les flottes provisionnées, consultez. Propriétés du parc provisionné

S'il Fleet est omis, la valeur par défaut estLinux.x86-64.Large.

Interface utilisateur correspondante : onglet Configuration/parc de calcul - facultatif

Timeout

(action-name/Timeout)

(Facultatif)

Spécifiez la durée en minutes (YAMLéditeur) ou en heures et minutes (éditeur visuel) pendant laquelle l'action peut être exécutée avant la CodeCatalyst fin de l'action. Le minimum est de 5 minutes et le maximum est décrit dansQuotas pour les flux de travail dans CodeCatalyst. Le délai d'expiration par défaut est le même que le délai d'expiration maximal.

Interface utilisateur correspondante : onglet Configuration/Délai d'expiration - facultatif

Environment

(action-name/Environment)

(Facultatif)

Spécifiez l' CodeCatalyst environnement à utiliser avec l'action. L'action se connecte à Compte AWS l'Amazon facultatif VPC spécifié dans l'environnement choisi. L'action utilise le IAM rôle par défaut spécifié dans l'environnement pour se connecter au Compte AWS, et utilise le IAM rôle spécifié dans la VPCconnexion Amazon pour se connecter à AmazonVPC.

Note

Si le IAM rôle par défaut ne dispose pas des autorisations requises par l'action, vous pouvez configurer l'action pour utiliser un autre rôle. Pour plus d’informations, consultez Modifier le IAM rôle d'une action.

Pour plus d'informations sur les environnements, reportez-vous Déploiement dans Comptes AWS et VPCs aux sections etCréation d'un environnement.

Interface utilisateur correspondante : onglet Configuration/Environnement

Name

(action-name/Environment/Name)

(Obligatoire s'Environmentil est inclus)

Spécifiez le nom de l'environnement existant que vous souhaitez associer à l'action.

Interface utilisateur correspondante : onglet Configuration/Environnement

Connections

(action-name/Environment/Connections)

(Facultatif)

Spécifiez la connexion au compte à associer à l'action. Vous pouvez spécifier un maximum d'une connexion à un compte sousEnvironment.

Si vous ne spécifiez pas de connexion au compte :

L'action utilise la Compte AWS connexion et le IAM rôle par défaut spécifiés dans l'environnement de la CodeCatalyst console. Pour plus d'informations sur l'ajout d'une connexion à un compte et d'un IAM rôle par défaut dans l'environnement, consultezCréation d'un environnement.
Le IAM rôle par défaut doit inclure les politiques et les autorisations requises par l'action. Pour déterminer quelles sont ces politiques et autorisations, consultez la description de la propriété Role dans la documentation de YAML définition de l'action.

Pour plus d'informations sur les connexions aux comptes, consultezPermettre l'accès aux AWS ressources avec Connected Comptes AWS. Pour plus d'informations sur l'ajout d'une connexion de compte à un environnement, consultezCréation d'un environnement.

Interface utilisateur correspondante : onglet Configuration/Environnement/Contenu my-environment? /menu à trois points/ Changer de rôle

Name

(action-name/Environment/Connections/Name)

(Obligatoire s'Connectionsil est inclus)

Spécifiez le nom de la connexion au compte.

Interface utilisateur correspondante : onglet Configuration/Environnement/Contenu my-environment? /menu à trois points/ Changer de rôle

Role

(action-name/Environment/Connections/Role)

(Obligatoire s'Connectionsil est inclus)

Spécifiez le nom du IAM rôle que cette action utilise pour accéder et opérer dans AWS des services tels qu'Amazon S3 et AmazonECR. Assurez-vous que ce rôle est ajouté à votre Compte AWS connexion dans votre espace. Pour ajouter un IAM rôle à une connexion à un compte, consultezAjouter IAM des rôles aux connexions aux comptes.

Si vous ne spécifiez aucun IAM rôle, l'action utilise le IAM rôle par défaut répertorié dans l'environnement de la CodeCatalyst console. Si vous utilisez le rôle par défaut dans l'environnement, assurez-vous qu'il est conforme aux politiques suivantes.

Note

Vous pouvez utiliser le CodeCatalystWorkflowDevelopmentRole-spaceName rôle avec cette action. Pour plus d’informations sur ce rôle, consultez Création du CodeCatalystWorkflowDevelopmentRole-spaceNamerôle pour votre compte et votre espace. Sachez que le CodeCatalystWorkflowDevelopmentRole-spaceName rôle dispose d'autorisations d'accès complètes, ce qui peut présenter un risque de sécurité. Nous vous recommandons de n'utiliser ce rôle que dans les didacticiels et les scénarios où la sécurité est moins préoccupante.

Avertissement

Limitez les autorisations à celles requises par l'GitHub action Action. L'utilisation d'un rôle doté d'autorisations plus étendues peut présenter un risque de sécurité.

Interface utilisateur correspondante : onglet Configuration/Environnement/Contenu my-environment? /menu à trois points/ Changer de rôle

Inputs

(action-name/Inputs)

(Facultatif)

La Inputs section définit les données dont une action a besoin lors de l'exécution d'un flux de travail.

Note

Un maximum de quatre entrées (une source et trois artefacts) sont autorisées par action GitHub Actions. Les variables ne sont pas prises en compte dans ce total.

Si vous devez faire référence à des fichiers résidant dans différentes entrées (par exemple, une source et un artefact), l'entrée source est l'entrée principale et l'artefact est l'entrée secondaire. Les références aux fichiers dans les entrées secondaires utilisent un préfixe spécial pour les distinguer du fichier principal. Pour plus de détails, consultez Exemple : Référencement de fichiers dans plusieurs artefacts.

Interface utilisateur correspondante : onglet Entrées

Sources

(action-name/Inputs/Sources)

(Facultatif)

Spécifiez les étiquettes qui représentent les référentiels sources qui seront nécessaires à l'action. Actuellement, la seule étiquette prise en charge estWorkflowSource, qui représente le référentiel source dans lequel votre fichier de définition de flux de travail est stocké.

Si vous omettez une source, vous devez spécifier au moins un artefact d'entrée sous. action-name/Inputs/Artifacts

Pour plus d'informations sur les sources, consultez Connecter les référentiels sources aux flux de travail.

Interface utilisateur correspondante : onglet Entrées/Sources - facultatif

Artifacts - input

(action-name/Inputs/Artifacts)

(Facultatif)

Spécifiez les artefacts des actions précédentes que vous souhaitez fournir en entrée pour cette action. Ces artefacts doivent déjà être définis en tant qu'artefacts de sortie dans les actions précédentes.

Si vous ne spécifiez aucun artefact d'entrée, vous devez spécifier au moins un référentiel source sousaction-name/Inputs/Sources.

Pour plus d'informations sur les artefacts, y compris des exemples, consultezPartage d'artefacts et de fichiers entre les actions.

Note

Si la liste déroulante Artéfacts - optionnelle n'est pas disponible (éditeur visuel), ou si vous recevez des erreurs lorsque vous validez votre YAML (YAMLéditeur), c'est peut-être parce que l'action ne prend en charge qu'une seule entrée. Dans ce cas, essayez de supprimer l'entrée source.

Interface utilisateur correspondante : onglet Entrées/Artefacts - facultatif

Variables - input

(action-name/Inputs/Variables)

(Facultatif)

Spécifiez une séquence de paires nom/valeur qui définissent les variables d'entrée que vous souhaitez mettre à la disposition de l'action. Les noms de variables sont limités aux caractères alphanumériques (a-z, A-Z, 0-9), aux tirets (-) et aux traits de soulignement (_). Les espaces ne sont pas autorisés. Vous ne pouvez pas utiliser de guillemets pour activer les caractères spéciaux et les espaces dans les noms de variables.

Pour plus d'informations sur les variables, y compris des exemples, consultezUtilisation de variables dans les flux de travail.

Interface utilisateur correspondante : onglet Entrées/Variables - facultatif

Outputs

(action-name/Outputs)

(Facultatif)

Définit les données produites par l'action lors de l'exécution d'un flux de travail.

Interface utilisateur correspondante : onglet Sorties

Artifacts - output

(action-name/Outputs/Artifacts)

(Facultatif)

Spécifiez le nom d'un artefact généré par l'action. Les noms d'artifact doivent être uniques dans un flux de travail et sont limités aux caractères alphanumériques (a-z, A-Z, 0-9) et aux traits de soulignement (_). Les espaces, les tirets (-) et les autres caractères spéciaux ne sont pas autorisés. Vous ne pouvez pas utiliser de guillemets pour activer les espaces, les tirets et autres caractères spéciaux dans les noms d'artefacts en sortie.

Pour plus d'informations sur les artefacts, y compris des exemples, consultezPartage d'artefacts et de fichiers entre les actions.

Interface utilisateur correspondante : onglet Sorties/Artefacts

Name

(action-name/Outputs/Artifacts/Name)

(Obligatoire s'Artifacts - outputil est inclus)

Pour plus d'informations sur les artefacts, y compris des exemples, consultezPartage d'artefacts et de fichiers entre les actions.

Interface utilisateur correspondante : onglet Sorties/Artifacts/Ajouter un artefact/Créer un nom d'artefact

Files

(action-name/Outputs/Artifacts/Files)

(Obligatoire s'Artifacts - outputil est inclus)

Spécifiez les fichiers CodeCatalyst inclus dans l'artefact généré par l'action. Ces fichiers sont générés par l'action du flux de travail lorsqu'elle s'exécute et sont également disponibles dans votre référentiel source. Les chemins de fichiers peuvent résider dans un référentiel source ou dans un artefact issu d'une action précédente, et sont relatifs au référentiel source ou à la racine de l'artefact. Vous pouvez utiliser des modèles globulaires pour définir des chemins. Exemples :

Pour spécifier un seul fichier situé à la racine de l'emplacement de votre build ou de votre référentiel source, utilisezmy-file.jar.
Pour spécifier un seul fichier dans un sous-répertoire, utilisez directory/my-file.jar oudirectory/subdirectory/my-file.jar.
Pour spécifier tous les fichiers, utilisez"**/*". Le modèle ** glob indique qu'il doit correspondre à un nombre quelconque de sous-répertoires.
Pour spécifier tous les fichiers et répertoires d'un répertoire nommédirectory, utilisez"directory/**/*". Le modèle ** glob indique qu'il doit correspondre à un nombre quelconque de sous-répertoires.
Pour spécifier tous les fichiers d'un répertoire nommédirectory, mais aucun de ses sous-répertoires, utilisez"directory/*".

Note

Si le chemin de votre fichier comporte un ou plusieurs astérisques (*) ou autres caractères spéciaux, mettez-le entre guillemets (). "" Pour plus d'informations sur les caractères spéciaux, consultezConsignes et conventions de syntaxe.

Pour plus d'informations sur les artefacts, y compris des exemples, consultezPartage d'artefacts et de fichiers entre les actions.

Note

Vous devrez peut-être ajouter un préfixe au chemin du fichier pour indiquer dans quel artefact ou dans quelle source le trouver. Pour plus d’informations, consultez Référencement des fichiers du référentiel source et Référencement de fichiers dans un artefact.

Interface utilisateur correspondante : onglet Sorties/Artifacts/Ajouter un artefact/Fichiers produits par build

Variables - output

(action-name/Outputs/Variables)

(Facultatif)

Spécifiez les variables que vous souhaitez que l'action exporte afin qu'elles puissent être utilisées par les actions suivantes.

Pour plus d'informations sur les variables, y compris des exemples, consultezUtilisation de variables dans les flux de travail.

Interface utilisateur correspondante : onglet Sorties/Variables/Ajouter une variable

nom-variable-1

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

(Facultatif)

Spécifiez le nom de la variable que vous souhaitez que l'action exporte. Cette variable doit déjà être définie dans la Steps section Inputs ou de la même action.

Pour plus d'informations sur les variables, y compris des exemples, consultezUtilisation de variables dans les flux de travail.

Interface utilisateur correspondante : onglet Sorties/Variables/Ajouter une variable/Nom

AutoDiscoverReports

(action-name/Outputs/AutoDiscoverReports)

(Facultatif)

Définit la configuration de la fonctionnalité de découverte automatique.

Lorsque vous activez la découverte automatique, les CodeCatalyst recherches Inputs sont toutes transmises à l'action ainsi que tous les fichiers générés par l'action elle-même, à la recherche de rapports de test, de couverture de code et d'analyse de la composition logicielle (SCA). Pour chaque rapport trouvé, le CodeCatalyst transforme en CodeCatalyst rapport. Un CodeCatalyst rapport est un rapport entièrement intégré au CodeCatalyst service et qui peut être consulté et manipulé via la CodeCatalyst console.

Note

Par défaut, la fonction de découverte automatique inspecte tous les fichiers. Vous pouvez limiter les fichiers inspectés à l'aide des ExcludePaths propriétés IncludePaths or.

Interface utilisateur correspondante : aucune

Enabled

(action-name/Outputs/AutoDiscoverReports/Enabled)

(Facultatif)

Activez ou désactivez la fonction de découverte automatique.

Les valeurs valides sont true ou false.

S'il Enabled est omis, la valeur par défaut esttrue.

Interface utilisateur correspondante : onglet Sorties/Rapports/Découverte automatique des rapports

ReportNamePrefix

(action-name/Outputs/AutoDiscoverReports/ReportNamePrefix)

(Obligatoire s'AutoDiscoverReportsil est inclus et activé)

Spécifiez un préfixe qui CodeCatalyst précède tous les rapports trouvés afin de nommer les rapports associés. CodeCatalyst Par exemple, si vous spécifiez le préfixe « et » et CodeCatalyst que vous découvrez automatiquement deux rapports de testTestSuiteTwo.xml, les CodeCatalyst rapports associés seront nommés TestSuiteOne.xml AutoDiscoveredTestSuiteOne et. AutoDiscovered AutoDiscoveredTestSuiteTwo

Interface utilisateur correspondante : onglet Sorties/Rapports/Découverte automatique des rapports/Préfixe du rapport

IncludePaths

(action-name/Outputs/AutoDiscoverReports/IncludePaths)

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

(Obligatoire s'AutoDiscoverReportsil est inclus et activé, ou s'il Reports est inclus)

Spécifiez les fichiers et les chemins de fichiers CodeCatalyst inclus lors de la recherche de rapports bruts. Par exemple, si vous le spécifiez"/test/report/*", CodeCatalyst recherche l'intégralité de l'image de construction utilisée par l'action à la recherche du /test/report/* répertoire. Lorsqu'il trouve ce répertoire, CodeCatalyst il recherche des rapports dans ce répertoire.

Note

Si cette propriété est omise, la valeur par défaut est"**/*", ce qui signifie que la recherche inclut tous les fichiers, quel que soit leur chemin.

Note

Pour les rapports configurés manuellement, IncludePaths il doit s'agir d'un modèle global correspondant à un seul fichier.

Interface utilisateur correspondante :

Onglet Sorties/Rapports/Découverte automatique des rapports/« Inclure/Exclure les chemins »/Inclure les chemins
Onglet Sorties/Rapports/Configuration manuelle des rapports/report-name-1/'Inclure/exclure les chemins'/Inclure les chemins

ExcludePaths

(action-name/Outputs/AutoDiscoverReports/ExcludePaths)

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

(Facultatif)

Spécifiez les fichiers et les chemins de fichiers à CodeCatalyst exclure lors de la recherche de rapports bruts. Par exemple, si vous le spécifiez"/test/my-reports/**/*", ne CodeCatalyst recherchera pas de fichiers dans le /test/my-reports/ répertoire. Pour ignorer tous les fichiers d'un répertoire, utilisez le modèle **/* glob.

Note

Interface utilisateur correspondante :

Onglet Sorties/Rapports/Découverte automatique des rapports/« Inclure/Exclure des chemins »/Exclure des chemins
Onglet Sorties/Rapports/Configuration manuelle des rapports/report-name-1/'Inclure/exclure des chemins'/Exclure des chemins

SuccessCriteria

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria)

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

(Facultatif)

Spécifiez les critères de réussite pour les rapports de test, de couverture du code, d'analyse de la composition logicielle (SCA) et d'analyse statique (SA).

Pour plus d’informations, consultez Configuration des critères de réussite pour les rapports.

Interface utilisateur correspondante :

Onglet Produits/Rapports/Découverte automatique des rapports/Critères de réussite
Onglet Sorties/Rapports/Configuration manuelle des rapports/report-name-1/Critères de réussite

PassRate

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

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

(Facultatif)

Spécifiez le pourcentage de tests dans un rapport de test qui doivent être réussis pour que le CodeCatalyst rapport associé soit marqué comme réussi. Les valeurs valides incluent les nombres décimaux. Par exemple, 50, 60.5. Les critères relatifs au taux de réussite ne sont appliqués qu'aux rapports de test. Pour plus d'informations sur les rapports de test, consultezRapports d'essais.

Interface utilisateur correspondante :

Onglet Produits/Rapports/Découverte automatique des rapports/Critères de succès/Taux de réussite
Onglet Sorties/Rapports/Configuration manuelle des rapports/report-name-1/Critères de succès/ Taux de réussite

LineCoverage

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

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

(Facultatif)

Spécifiez le pourcentage de lignes d'un rapport de couverture de code qui doivent être couvertes pour que le CodeCatalyst rapport associé soit marqué comme transmis. Les valeurs valides incluent les nombres décimaux. Par exemple, 50, 60.5. Les critères de couverture de ligne sont appliqués uniquement aux rapports de couverture de code. Pour plus d'informations sur les rapports de couverture du code, consultezRapports sur la couverture du code.

Interface utilisateur correspondante :

Onglet Produits/Rapports/Découverte automatique des rapports/Critères de succès/Couverture des lignes
Onglet Sorties/Rapports/Configuration manuelle des rapports/report-name-1/Critères de succès/ Couverture des lignes

BranchCoverage

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

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

(Facultatif)

Spécifiez le pourcentage de branches dans un rapport de couverture de code qui doivent être couvertes pour que le CodeCatalyst rapport associé soit marqué comme transmis. Les valeurs valides incluent les nombres décimaux. Par exemple, 50, 60.5. Les critères de couverture des succursales sont appliqués uniquement aux rapports de couverture par code. Pour plus d'informations sur les rapports de couverture du code, consultezRapports sur la couverture du code.

Interface utilisateur correspondante :

Onglet Produits/Rapports/Découverte automatique des rapports/Critères de succès/Couverture des succursales
Onglet Sorties/Rapports/Configuration manuelle des rapports/report-name-1/Critères de succès/ Couverture des succursales

Vulnerabilities

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

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

(Facultatif)

Spécifiez le nombre maximum et la gravité des vulnérabilités autorisées dans le SCA rapport pour que le CodeCatalyst rapport associé soit marqué comme transmis. Pour définir les vulnérabilités, vous devez spécifier :

La gravité minimale des vulnérabilités que vous souhaitez inclure dans le décompte. Les valeurs valides, de la plus sévère à la moins sévère, sont les suivantes : CRITICALHIGH,MEDIUM,LOW,,INFORMATIONAL.

Par exemple, si vous le souhaitezHIGH, HIGH les CRITICAL vulnérabilités seront comptabilisées.
Le nombre maximum de vulnérabilités de la gravité spécifiée que vous souhaitez autoriser. Le dépassement de ce nombre entraîne le marquage CodeCatalyst du rapport comme ayant échoué. Les valeurs valides sont des nombres entiers.

Les critères de vulnérabilité ne sont appliqués qu'aux SCA rapports. Pour plus d'informations sur SCA les rapports, consultezRapports d'analyse de la composition des logiciels.

Pour spécifier la sévérité minimale, utilisez la Severity propriété. Pour spécifier le nombre maximum de vulnérabilités, utilisez la Number propriété.

Pour plus d'informations sur SCA les rapports, consultezTypes de rapports sur la qualité.

Interface utilisateur correspondante :

Onglet Produits/Rapports/Découverte automatique des rapports/Critères de succès/Vulnérabilités
Onglet Sorties/Rapports/Configuration manuelle des rapports/report-name-1/Critères de succès/ Vulnérabilités

Reports

(action-name/Outputs/Reports )

(Facultatif)

Section qui spécifie la configuration des rapports de test.

Interface utilisateur correspondante : onglet Sorties/Rapports

nom-du-rapport-1

(action-name/Outputs/Reports/nom-du rapport-1)

(Obligatoire s'Reportsil est inclus)

Le nom que vous souhaitez donner au CodeCatalyst rapport qui sera généré à partir de vos rapports bruts.

Interface utilisateur correspondante : onglet Sorties/Rapports/Configuration manuelle des rapports/Nom du rapport

Format

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

(Obligatoire s'Reportsil est inclus)

Spécifiez le format de fichier que vous utilisez pour vos rapports. Les valeurs possibles sont les suivantes.

Pour les rapports de test :
- Pour CucumberJSON, spécifiez Cucumber (éditeur visuel) ou CUCUMBERJSON (YAMLéditeur).
- Pour JUnitXML, spécifiez JUnit(éditeur visuel) ou JUNITXML (YAMLéditeur).
- Pour NUnitXML, spécifiez NUnit(éditeur visuel) ou NUNITXML (YAMLéditeur).
- Pour NUnit 3XML, spécifiez NUnit3(éditeur visuel) ou NUNIT3XML (YAMLéditeur).
- Pour Visual StudioTRX, spécifiez Visual Studio TRX (éditeur visuel) ou VISUALSTUDIOTRX (YAMLéditeur).
- Pour TestNGXML, spécifiez TestNG (éditeur visuel) ou TESTNGXML (éditeur). YAML
Pour les rapports sur la couverture du code :
- Pour CloverXML, spécifiez Clover (éditeur visuel) ou CLOVERXML (YAMLéditeur).
- Pour CoberturaXML, spécifiez Cobertura (éditeur visuel) ou COBERTURAXML (éditeur). YAML
- Pour JaCoCo XML, spécifiez JaCoCo(éditeur visuel) ou JACOCOXML (YAMLéditeur).
- Pour les SimpleCov JSON fichiers générés par simplecov, et non par simplecov-json, spécifiez Simplecov (éditeur visuel) ou (éditeur). SIMPLECOV YAML
Pour les rapports d'analyse de la composition logicielle (SCA) :
- PourSARIF, spécifiez SARIF(éditeur visuel) ou SARIFSCA (YAMLéditeur).

Interface utilisateur correspondante : onglet Sorties/Rapports/Configuration manuelle des rapports/Ajouter un rapport/report-name-1/Type de rapport et format de rapport

Configuration

(action-name/Configuration)

(Obligatoire) Section dans laquelle vous pouvez définir les propriétés de configuration de l'action.

Interface utilisateur correspondante : onglet Configuration

Steps

(action-name/Configuration/Steps)

(Obligatoire)

Spécifiez votre code GitHub d'action tel qu'il apparaît sur la page de détails de l'action dans GitHub Marketplace. Ajoutez le code en suivant les instructions suivantes :

Collez le code de la steps: section GitHub Action dans la Steps: section du CodeCatalyst flux de travail. Le code commence par un tiret (-) et ressemble à ce qui suit.

GitHub code à coller :
```
- name: Lint Code Base
  uses: github/super-linter@v4
  env:
    VALIDATE_ALL_CODEBASE: false
    DEFAULT_BRANCH: master
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Passez en revue le code que vous venez de coller et modifiez-le si nécessaire afin qu'il soit conforme aux CodeCatalyst normes. Par exemple, avec le bloc de code précédent, vous pouvez supprimer le code dans red italics, et ajoutez le code en gras.

CodeCatalyst flux de travail yaml :
```
Steps:      
   - name: Lint Code Base
     uses: github/super-linter@v4
     env:
       VALIDATE_ALL_CODEBASE: false
       DEFAULT_BRANCH: mastermain
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Pour le code supplémentaire inclus dans l' GitHub action mais qui n'existe pas dans la steps: section, ajoutez-le au CodeCatalyst flux de travail à l'aide d'un code CodeCatalyst équivalent. Vous pouvez les consulter YAMLDéfinition du flux de travail pour avoir un aperçu de la manière dont vous pourriez porter votre GitHub code CodeCatalyst. Les étapes de migration détaillées ne sont pas abordées dans ce guide.

Voici un exemple de la manière de spécifier des chemins de fichiers dans une action 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

Pour plus d'informations sur la spécification des chemins de fichiers, reportez-vous Référencement des fichiers du référentiel source aux sections etRéférencement de fichiers dans un artefact.

Interface utilisateur correspondante : onglet Configuration/Actions GitHub YAML

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Référencement des paramètres GitHub de sortie

Configuration des images de calcul et d'exécution