Création et test de la définition YAML de l'action - Amazon CodeCatalyst
nom-actionIdentifierDependsOnComputeTypeFleetTimeoutEnvironmentNameConnectionsNameRoleCachingFileCachingnom-clé-1PathRestoreKeysInputsSourcesArtifacts - inputVariables - inputOutputsArtifacts - outputNameFilesVariables - outputnom-variable-1AutoDiscoverReportsEnabledReportNamePrefixIncludePathsExcludePathsSuccessCriteriaPassRateLineCoverageBranchCoverageVulnerabilitiesStaticAnalysisBugStaticAnalysisSecurityStaticAnalysisQualityStaticAnalysisFindingReportsnom-du-rapport-1FormatConfigurationContainerRegistryImageStepsPackagesNpmConfigurationPackageRegistriesPackagesRepositoryScopes

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Création et test de la définition YAML de l'action

Voici la définition YAML des actions de construction et de test. Il existe une référence pour deux actions car leurs propriétés YAML sont très similaires.

Cette définition d'action existe sous forme de 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 Définition du flux de travail YAML.

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

Note

La plupart des propriétés YAML suivantes 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 propriété YAML 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/build@v1 | aws/managed-test@v1
    DependsOn:
      - dependent-action-name-1
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Caching:  
      FileCaching:
        key-name-1:
          Path: file1.txt
          RestoreKeys:
            - restore-key-1
    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: 
            - build-output/artifact-1.jar
            - "build-output/build*"
        - Name: output-artifact-2
          Files:
            - build-output/artifact-2.1.jar
            - build-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
          StaticAnalysisBug:
            Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
            Number: whole-number
          StaticAnalysisSecurity:
            Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
            Number: whole-number
          StaticAnalysisQuality:
            Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
            Number: whole-number
          StaticAnalysisFinding:
            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
            StaticAnalysisBug:
                Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
                Number: whole-number
            StaticAnalysisSecurity:
                Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
                Number: whole-number
            StaticAnalysisQuality:
                Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
                Number: whole-number
            StaticAnalysisFinding:
                Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
                Number: whole-number
    Configuration:
      Container:
        Registry: registry
        Image: image
      Steps:
        - Run: "step 1"
        - Run: "step 2"
      Packages:
        NpmConfiguration:
          PackageRegistries:
            - PackagesRepository: package-repository
              Scopes:
                - "@scope"

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/nom de l'action

Identifier

(nom-action/) Identifier

Identifie l'action. Ne modifiez pas cette propriété, sauf si vous souhaitez modifier la version. Pour plus d’informations, consultez Spécifier la version majeure, mineure ou corrective d'une action.

À utiliser aws/build@v1 pour créer des actions.

À utiliser aws/managed-test@v1 pour les actions de test.

Interface utilisateur correspondante : diagramme de flux de travail/Action-Name/ aws/build @v1 |aws/managed-test @v1 label

DependsOn

(nom-action/) 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. Configuration des actions pour qu'elles dépendent d'autres actions

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

Compute

(nom-action/) 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

Type

(type de nom d'action/Compute/)

(Obligatoire s'Computeil est inclus)

Type de moteur de calcul. Vous pouvez utiliser l'une des valeurs suivantes :

  • EC2 (éditeur visuel) ou EC2 (éditeur YAML)

    Optimisé pour la flexibilité lors des courses d'action.

  • Lambda (éditeur visuel) ou Lambda (éditeur YAML)

    Vitesses de démarrage des actions optimisées.

Pour plus d'informations sur les types de calcul, veuillez consulter Types de calcul.

Interface utilisateur correspondante : onglet Configuration/Type de calcul

Fleet

(nom de l'action /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

Timeout

(nom-action/) Timeout

(Facultatif)

Spécifiez la durée en minutes (éditeur YAML) 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 workflows. 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

(nom-action/) Environment

(Facultatif)

Spécifiez l' CodeCatalyst environnement à utiliser avec l'action.

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

Interface utilisateur correspondante : onglet Configuration/Environnement

Name

(nom de l'action /Environment/ Name)

(Facultatif)

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

Interface utilisateur correspondante : onglet Configuration/nom de l'environnement

Connections

(nom de l'action /Environment/ Connections)

(Facultatif)

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

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 la façon d'associer une connexion à un compte à votre environnement, consultezCréation d'un environnement.

Interface utilisateur correspondante : onglet Configuration/

Name

(nom de l'action /Environment/Connections/ Name)

(Facultatif)

Spécifiez le nom de la connexion au compte.

Interface utilisateur correspondante : onglet Configuration/

Role

(nom de l'action /Environment/Connections/ Role)

(Facultatif)

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

Note

Vous pouvez peut-être spécifier le nom du CodeCatalystWorkflowDevelopmentRole-spaceName rôle ici, à condition qu'il dispose des autorisations suffisantes. 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 très étendues, 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 les actions de génération et de test. L'utilisation d'un rôle doté d'autorisations étendues peut présenter un risque de sécurité.

Interface utilisateur correspondante : onglet Configuration/

Caching

(nom-action/) Caching

(Facultatif)

Section dans laquelle vous pouvez spécifier un cache pour enregistrer les fichiers sur disque et les restaurer à partir de ce cache lors des exécutions de flux de travail suivantes.

Pour plus d'informations sur la mise en cache de fichiers, consultezMise en cache des fichiers entre les exécutions du flux de travail.

Interface utilisateur correspondante : onglet Configuration/mise en cache de fichiers - facultatif

FileCaching

(nom de l'action /Caching/ FileCaching)

(Facultatif)

Section qui spécifie la configuration d'une séquence de caches.

Interface utilisateur correspondante : onglet Configuration/Mise en cache de fichiers - facultatif/Ajouter un cache

nom-clé-1

(nom-action-clé-nom-1/Caching/FileCaching/)

(Facultatif)

Spécifiez le nom de votre propriété de cache principale. Les noms des propriétés du cache doivent être uniques dans votre flux de travail. Chaque action peut comporter jusqu'à cinq entréesFileCaching.

Interface utilisateur correspondante : onglet Configuration/Mise en cache des fichiers - Facultatif/Ajouter un cache/une clé

Path

(nom-action /Caching/FileCaching/ nom-clé-1/) Path

(Facultatif)

Spécifiez le chemin associé à votre cache.

Interface utilisateur correspondante : onglet Configuration/mise en cache des fichiers - Facultatif/Ajouter un cache/un chemin

RestoreKeys

(nom-action /Caching/FileCaching/ nom-clé-1/) RestoreKeys

(Facultatif)

Spécifiez la clé de restauration à utiliser comme solution de secours lorsque la propriété de cache principale est introuvable. Les noms des clés de restauration doivent être uniques dans votre flux de travail. Chaque cache peut contenir jusqu'à cinq entréesRestoreKeys.

Interface utilisateur correspondante : onglet Configuration/Mise en cache des fichiers - Facultatif/Ajout de clés de cache/restauration - facultatif

Inputs

(nom-action/) 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 de construction ou action de test. 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

(nom de l'action /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 Connexion d'un flux de travail à un référentiel source.

Interface utilisateur correspondante : aucune

Artifacts - input

(nom de l'action /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 de données entre les actions d'un flux de travail à l'aide d'artefacts.

Note

Si la liste déroulante Artéfacts - optionnelle n'est pas disponible (éditeur visuel), ou si vous recevez des erreurs lors de la validation de votre YAML (éditeur YAML), 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

(nom de l'action /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, consultezConfiguration et utilisation de variables dans un flux de travail.

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

Outputs

(nom-action/) 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

(nom de l'action /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 de données entre les actions d'un flux de travail à l'aide d'artefacts.

Interface utilisateur correspondante : onglet Sorties/Artefacts

Name

(nom de l'action /Outputs/Artifacts/ Name)

(Obligatoire s'Artifacts - outputil est inclus)

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 de données entre les actions d'un flux de travail à l'aide d'artefacts.

Interface utilisateur correspondante : onglet Sorties/Artifacts/Nouvelle sortie/Nom de l'artefact de construction

Files

(nom de l'action /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 de données entre les actions d'un flux de travail à l'aide d'artefacts.

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 de fichiers dans un référentiel source et Référencement de fichiers dans un artefact.

Interface utilisateur correspondante : onglet Sorties/Artefacts/Nouvelle sortie/Fichiers produits par build

Variables - output

(nom de l'action /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, consultezConfiguration et utilisation de variables dans un flux de travail.

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

nom-variable-1

(nom-action-nom-variable-1/Outputs/Variables/)

(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, consultezConfiguration et utilisation de variables dans un flux de travail.

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

AutoDiscoverReports

(nom de l'action /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 : onglet Sorties/Rapports/Rapports de découverte automatique

Enabled

(nom de l'action /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/Rapports de découverte automatique

ReportNamePrefix

(nom de l'action /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 deAutoDiscovered, et que vous CodeCatalyst découvrez automatiquement deux rapports de testTestSuiteTwo.xml, TestSuiteOne.xml et, les CodeCatalyst rapports associés seront nommés AutoDiscoveredTestSuiteOne et. AutoDiscoveredTestSuiteTwo

Interface utilisateur correspondante : onglet Sorties/Rapports/Nom du préfixe

IncludePaths

(nom de l'action /Outputs/AutoDiscoverReports/ IncludePaths)

Ou

(/Outputs/Reports/nom-action-nom-rapport-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 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.

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/Rapports de découverte automatique/Inclure/Exclure des chemins/Inclure des chemins

  • Onglet Sorties/Rapports/Configuration manuelle des rapports/nom-du-rapport-1 /Inclure/Exclure les chemins/ Inclure les chemins

ExcludePaths

(nom de l'action /Outputs/AutoDiscoverReports/ ExcludePaths)

Ou

(/Outputs/Reports/nom-action-nom-rapport-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

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.

Interface utilisateur correspondante :

  • Onglet Sorties/Rapports/Rapports de découverte automatique/Inclure/Exclure des chemins/Exclure des chemins

  • Onglet Sorties/Rapports/Configuration manuelle des rapports/nom-du-rapport-1 /Inclure/Exclure des chemins/Exclure des chemins

SuccessCriteria

(nom de l'action /Outputs/AutoDiscoverReports/ SuccessCriteria)

Ou

(/Outputs/Reports/nom-action-nom-rapport-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 Sortie/Rapports/Critères de réussite

PassRate

(nom de l'action /Outputs/AutoDiscoverReports/SuccessCriteria/ PassRate)

Ou

(nom-action-nom-rapport-1/Outputs/Reports/) /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 Sortie/Rapports/Critères de succès/Taux de réussite

LineCoverage

(nom de l'action /Outputs/AutoDiscoverReports/SuccessCriteria/ LineCoverage)

Ou

(nom-action-nom-rapport-1/Outputs/Reports/) /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 Sortie/Rapports/Critères de succès/Couverture des lignes

BranchCoverage

(nom de l'action /Outputs/AutoDiscoverReports/SuccessCriteria/ BranchCoverage)

Ou

(nom-action-nom-rapport-1/Outputs/Reports/) /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 de sortie/Rapports/Critères de succès/Couverture des branches

Vulnerabilities

(nom de l'action /Outputs/AutoDiscoverReports/SuccessCriteria/ Vulnerabilities)

Ou

(nom-action-nom-rapport-1/Outputs/Reports/) /SuccessCriteria/ Vulnerabilities

(Facultatif)

Spécifiez le nombre maximum et la gravité des vulnérabilités autorisées dans le rapport SCA 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 rapports SCA. Pour plus d'informations sur les rapports SCA, 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é.

Interface utilisateur correspondante : onglet de sortie/rapports/critères de succès/vulnérabilités

StaticAnalysisBug

(nom de l'action /Outputs/AutoDiscoverReports/SuccessCriteria/ StaticAnalysisBug)

Ou

(nom-action-nom-rapport-1/Outputs/Reports/) /SuccessCriteria/ StaticAnalysisBug

(Facultatif)

Spécifiez le nombre maximum et la gravité des bogues autorisés dans le rapport SA pour que le CodeCatalyst rapport associé soit marqué comme passé. Pour spécifier les bogues, vous devez spécifier :

  • La gravité minimale des bogues 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 bogues seront comptabilisés.

  • Le nombre maximum de bogues 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 bogues ne sont appliqués qu' PyLint aux rapports ESLint SA. Pour plus d'informations sur les rapports SA, consultezRapports d'analyse statiques.

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é.

Interface utilisateur correspondante : onglet de sortie/Rapports/Critères de succès/Bugs

StaticAnalysisSecurity

(nom de l'action /Outputs/AutoDiscoverReports/SuccessCriteria/ StaticAnalysisSecurity)

Ou

(nom-action-nom-rapport-1/Outputs/Reports/) /SuccessCriteria/ StaticAnalysisSecurity

(Facultatif)

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

  • La gravité minimale des failles de sécurité 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 failles CRITICAL de sécurité seront prises en compte.

  • Le nombre maximum de failles de sécurité 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é de sécurité ne s'appliquent qu' PyLint aux rapports ESLint SA. Pour plus d'informations sur les rapports SA, consultezRapports d'analyse statiques.

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é.

Interface utilisateur correspondante : onglet de sortie/rapports/critères de succès/vulnérabilités de sécurité

StaticAnalysisQuality

(nom de l'action /Outputs/AutoDiscoverReports/SuccessCriteria/ StaticAnalysisQuality)

Ou

(nom-action-nom-rapport-1/Outputs/Reports/) /SuccessCriteria/ StaticAnalysisQuality

(Facultatif)

Spécifiez le nombre maximum et la gravité des problèmes de qualité autorisés dans le rapport SA pour que le CodeCatalyst rapport associé soit marqué comme réussi. Pour définir les problèmes de qualité, vous devez spécifier :

  • La gravité minimale des problèmes de qualité 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 problèmes CRITICAL de qualité seront pris en compte.

  • Le nombre maximum de problèmes de qualité 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 relatifs aux problèmes de qualité ne s'appliquent qu' PyLint aux rapports ESLint SA. Pour plus d'informations sur les rapports SA, consultezRapports d'analyse statiques.

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é.

Interface utilisateur correspondante : onglet de sortie/Rapports/Critères de succès/Problèmes de qualité

StaticAnalysisFinding

(nom de l'action /Outputs/AutoDiscoverReports/SuccessCriteria/ StaticAnalysisFinding)

Ou

(nom-action-nom-rapport-1/Outputs/Reports/) /SuccessCriteria/ StaticAnalysisFinding

(Facultatif)

Spécifiez le nombre maximum et la gravité des résultats autorisés dans le rapport SA pour que le CodeCatalyst rapport associé soit marqué comme adopté. Pour spécifier les résultats, vous devez spécifier :

  • La gravité minimale des résultats 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 résultats seront comptabilisés.

  • Le nombre maximum de résultats 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 résultats ne sont appliqués qu'aux rapports de la SARIF SA. Pour plus d'informations sur les rapports SA, consultezRapports d'analyse statiques.

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é.

Interface utilisateur correspondante : onglet de sortie/rapports/critères de succès/résultats

Reports

(nom de l'action /Outputs/ Reports)

(Facultatif)

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

Interface utilisateur correspondante : onglet Sorties/Rapports

nom-du-rapport-1

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

(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

(/Outputs/Reports/nom-action-nom-rapport-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 Cucumber JSON, spécifiez Cucumber (éditeur visuel) ou CUCUMBERJSON (éditeur YAML).

    • Pour JUnit XML, spécifiez JUnit (éditeur visuel) ou JUNITXML (éditeur YAML).

    • Pour NUnit XML, spécifiez NUnit (éditeur visuel) ou NUNITXML (éditeur YAML).

    • Pour NUnit 3 XML, spécifiez NUnit3 (éditeur visuel) ou NUNIT3XML (éditeur YAML).

    • Pour Visual Studio TRX, spécifiez Visual Studio TRX (éditeur visuel) ou VISUALSTUDIOTRX (éditeur YAML).

    • Pour TestNG XML, spécifiez TestNG (éditeur visuel) ou TESTNGXML (éditeur YAML).

  • Pour les rapports sur la couverture du code :

    • Pour Clover XML, spécifiez Clover (éditeur visuel) ou CLOVERXML (éditeur YAML).

    • Pour Cobertura XML, spécifiez Cobertura (éditeur visuel) ou COBERTURAXML (éditeur YAML).

    • Pour le JaCoCo XML, spécifiez JaCoCo(éditeur visuel) ou JACOCOXML (éditeur YAML).

    • Pour le SimpleCov JSON généré par simplecov, et non par simplecov-json, spécifiez Simplecov (éditeur visuel) ou (éditeur YAML). SIMPLECOV

  • Pour les rapports d'analyse de composition logicielle (SCA) :

    • Pour SARIF, spécifiez SARIF (éditeur visuel) ou SARIFSCA (éditeur YAML).

Interface utilisateur correspondante : onglet Sorties/Rapports/Configuration manuelle des rapports/Ajouter/configurer des rapports/nom-du-rapport-1 /Type de rapport et format de rapport

Configuration

(nom-action/) Configuration

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

Interface utilisateur correspondante : onglet Configuration

Container

(nom de l'action /Configuration/ Container)

(Facultatif)

Spécifiez l'image Docker, ou le conteneur, que l'action utilise pour terminer son traitement. Vous pouvez spécifier l'une des images actives fournies avec CodeCatalyst ou utiliser votre propre image. Si vous choisissez d'utiliser votre propre image, elle peut résider dans Amazon ECR, Docker Hub ou dans un autre registre. Si vous ne spécifiez aucune image Docker, l'action utilise l'une des images actives pour son traitement. Pour plus d'informations sur l'image active utilisée par défaut, consultezImages actives.

Pour plus d'informations sur la spécification de votre propre image Docker, consultezAffectation d'une image Docker d'environnement d'exécution personnalisée à une action.

Interface utilisateur correspondante : image Docker de l'environnement d'exécution - facultatif

Registry

(nom de l'action /Configuration/Container/ Registry)

(Obligatoire s'Containeril est inclus)

Spécifiez le registre dans lequel votre image est stockée. Les valeurs valides sont les suivantes :

  • CODECATALYST(éditeur YAML)

    L'image est enregistrée dans le CodeCatalyst registre.

  • Docker Hub (éditeur visuel) ou DockerHub (éditeur YAML)

    L'image est stockée dans le registre d'images de Docker Hub.

  • Autre registre (éditeur visuel) ou Other (éditeur YAML)

    L'image est stockée dans un registre d'images personnalisé. N'importe quel registre accessible au public peut être utilisé.

  • Amazon Elastic Container Registry (éditeur visuel) ou ECR (éditeur YAML)

    L'image est stockée dans un référentiel d'images Amazon Elastic Container Registry. Pour utiliser une image dans un référentiel Amazon ECR, cette action nécessite l'accès à Amazon ECR. Pour activer cet accès, vous devez créer un rôle IAM incluant les autorisations suivantes et une politique de confiance personnalisée. (Vous pouvez modifier un rôle existant pour inclure les autorisations et la politique, si vous le souhaitez.)

    Le rôle IAM doit inclure les autorisations suivantes dans sa politique de rôle :

    • ecr:BatchCheckLayerAvailability

    • ecr:BatchGetImage

    • ecr:GetAuthorizationToken

    • ecr:GetDownloadUrlForLayer

    Le rôle IAM doit inclure la politique de confiance personnalisée suivante :

    {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "",
            "Effect": "Allow",
            "Principal": {
                "Service":  [
                   "codecatalyst-runner.amazonaws.com",
                   "codecatalyst.amazonaws.com"
                 ]
            },
            "Action": "sts:AssumeRole"
        }
    ]
}

    Pour plus d'informations sur la création de rôles IAM, consultez la section Création d'un rôle à l'aide de politiques de confiance personnalisées (console) dans le guide de l'utilisateur IAM.

    Une fois le rôle créé, vous devez l'attribuer à l'action par le biais d'un environnement. Pour plus d’informations, consultez Associer un environnement, une connexion à un compte et un rôle IAM à une action de flux de travail.

Interface utilisateur correspondante : Amazon Elastic Container Registry, Docker Hub et autres options de registre

Image

(nom de l'action /Configuration/Container/ Image)

(Obligatoire s'Containeril est inclus)

Spécifiez l’un des éléments suivants :

  • Si vous utilisez un CODECATALYST registre, définissez l'image sur l'une des images actives suivantes :

    • CodeCatalystLinux_x86_64:2024_03

    • CodeCatalystLinux_x86_64:2022_11

    • CodeCatalystLinux_Arm64:2024_03

    • CodeCatalystLinux_Arm64:2022_11

    • CodeCatalystLinuxLambda_x86_64:2024_03

    • CodeCatalystLinuxLambda_x86_64:2022_11

    • CodeCatalystLinuxLambda_Arm64:2024_03

    • CodeCatalystLinuxLambda_Arm64:2022_11

    • CodeCatalystWindows_x86_64:2022_11

  • Si vous utilisez un registre Docker Hub, attribuez à l'image le nom de l'image Docker Hub et la balise facultative.

    Exemple : postgres:latest

  • Si vous utilisez un registre Amazon ECR, définissez l'image sur l'URI du registre Amazon ECR.

    Exemple : 111122223333.dkr.ecr.us-west-2.amazonaws.com/codecatalyst-ecs-image-repo

  • Si vous utilisez un registre personnalisé, définissez l'image sur la valeur attendue par le registre personnalisé.

Interface utilisateur correspondante : image docker de l'environnement d'exécution (si le registre l'estCODECATALYST), image Docker Hub (si le registre est Docker Hub), URL de l'image ECR (si le registre est Amazon Elastic Container Registry) et URL de l'image (si le registre est Autre registre).

Steps

(nom de l'action /Configuration/ Steps)

(Obligatoire)

Spécifiez les commandes shell que vous souhaitez exécuter pendant l'action d'installation, de configuration et d'exécution de vos outils de génération.

Voici un exemple de création d'un projet npm :

Steps:
  - Run: npm install
  - Run: npm run build

Voici un exemple de la manière de spécifier des chemins de fichiers :

Steps:
  - Run: cd $ACTION_BUILD_SOURCE_PATH_WorkflowSource/app  && cat file2.txt
  - Run: cd $ACTION_BUILD_SOURCE_PATH_MyBuildArtifact/build-output/  && cat file.txt

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

Interface utilisateur correspondante : onglet Configuration/commandes Shell

Packages

(nom de l'action /Configuration/ Packages)

(Facultatif)

Section dans laquelle vous pouvez spécifier un référentiel de packages que l'action utilise pour résoudre les dépendances. Les packages vous permettent de stocker et de partager en toute sécurité les packages logiciels utilisés pour le développement d'applications.

Pour plus d'informations sur les packages, consultezPubliez et partagez des progiciels dans CodeCatalyst.

Interface utilisateur correspondante : onglet Configuration/Packages

NpmConfiguration

(nom de l'action /Configuration/Packages/ NpmConfiguration)

(Obligatoire s'Packagesil est inclus)

Une section qui définit la configuration du format de package npm. Cette configuration est utilisée par une action lors de l'exécution d'un flux de travail.

Pour plus d'informations sur la configuration du package npm, consultezUtilisation de npm.

Interface utilisateur correspondante : onglet Configuration/Packages/Ajouter une configuration/npm

PackageRegistries

(nom de l'action /Configuration/Packages/NpmConfiguration/ PackageRegistries)

(Obligatoire s'Packagesil est inclus)

Section dans laquelle vous pouvez définir les propriétés de configuration d'une séquence de référentiels de packages.

Interface utilisateur correspondante : onglet Configuration/Packages/Ajouter une configuration/npm/ Ajouter un référentiel de packages

PackagesRepository

(nom de l'action /Configuration/Packages/NpmConfiguration/PackageRegistries/ PackagesRepository)

(Obligatoire s'Packagesil est inclus)

Spécifiez le nom du référentiel de CodeCatalyst packages que vous souhaitez utiliser par l'action.

Si vous spécifiez plusieurs référentiels par défaut, le dernier sera prioritaire.

Pour plus d'informations sur les référentiels de packages, consultezRéférentiels de packages.

Interface utilisateur correspondante : onglet Configuration/Packages/Ajouter une configuration/NPM/Ajouter un référentiel de paquets/Référentiel de packages

Scopes

(nom de l'action /Configuration/Packages/NpmConfiguration/PackageRegistries/ Scopes)

(Facultatif)

Spécifiez une séquence de portées que vous souhaitez définir dans votre registre de packages. Lors de la définition des étendues, le référentiel de packages spécifié est configuré comme registre pour toutes les étendues répertoriées. Si un package avec cette portée est demandé via le client npm, il utilisera ce référentiel au lieu du dépôt par défaut. Le nom de chaque étendue doit être préfixé par « @ ».

Si vous incluez des étendues de remplacement, le dernier référentiel sera prioritaire.

Si Scopes ce paramètre est omis, le référentiel de packages spécifié est configuré comme registre par défaut pour tous les packages utilisés par l'action.

Pour plus d'informations sur les étendues, reportez-vous à la section Espaces de noms de packages et Packages délimités.

Interface utilisateur correspondante : onglet Configuration/Packages/Ajouter une configuration/NPM/Ajouter un référentiel de paquets/Scopes - facultatif