Amazon n' CodeCatalyst est plus ouvert aux nouveaux clients. Les clients existants peuvent continuer à utiliser le service normalement. Pour de plus amples informations, veuillez consulter Comment effectuer une migration depuis CodeCatalyst.
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éez et testez des actions YAML
Voici la définition YAML des actions de génération 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 dans un fichier de définition de flux de travail plus large. Pour plus d’informations sur ce fichier, consultez Définition YAML du flux de travail.
Choisissez une propriété YAML dans le code suivant pour voir sa description.
Note
La plupart des propriétés YAML qui suivent 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 Top-level propriétés 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"
ExportAuthorizationToken: true | false
nom de l'action
(Obligatoire)
Spécifiez le nom de l'action. Tous les noms d'actions doivent être uniques dans le flux de travail. Les noms des actions sont limités aux caractères alphanumériques (a-z, 0-9) A-Z, 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 des actions.
Interface utilisateur correspondante : onglet Configuration/Nom de l'action
Identifiant
(action-name/Identifier)
Identifie l'action. Ne modifiez pas cette propriété sauf si vous souhaitez modifier la version. Pour de plus amples informations, veuillez consulter Spécifier la version de l'action à utiliser.
À utiliser aws/build@v1 pour créer des actions.
À utiliser aws/managed-test@v1 pour les actions de test.
Interface utilisateur correspondante : Workflow diagram/Action -nom/étiquette aws/build@v1|aws/managed-test@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 de », consultez. Actions de séquençage
Interface utilisateur correspondante : onglet Entrées/dépend de - facultatif
Calcul
(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 de plus amples informations, veuillez consulter Partage du calcul entre les actions.
Interface utilisateur correspondante : aucune
Type
(action-name/Compute/Tapez)
(Obligatoire s'Calculil 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, consultez Types de calcul.
Interface utilisateur correspondante : onglet Configuration/Type de calcul
Flotte
(action-name/Compute/Fleet)
(Facultatif)
Spécifiez la machine ou le parc qui exécutera votre flux de travail ou les actions de votre flux de travail. Avec les flottes à la demande, lorsqu'une action démarre, le flux de travail fournit les ressources dont elle 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, consultezOn-demand propriétés de la flotte.
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 à traiter les actions immédiatement. Pour plus d'informations sur les flottes provisionnées, consultez. Propriétés de la flotte de véhicules provisionnée
Si cette valeur Fleet est omise, la valeur par défaut estLinux.x86-64.Large.
Interface utilisateur correspondante : onglet Configuration/Parc de calcul
Timeout
(action-name/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 flux de travail dans CodeCatalyst. Le délai d'attente par défaut est le même que le délai maximum.
Interface utilisateur correspondante : onglet Configuration/Délai d'attente - facultatif
Environnement
(action-name/Environment)
(Facultatif)
Spécifiez l' CodeCatalyst environnement à utiliser avec l'action. L'action se connecte au Compte AWS VPC Amazon facultatif spécifié dans l'environnement choisi. L'action utilise le rôle IAM par défaut spécifié dans l'environnement pour se connecter au Compte AWS, et utilise le rôle IAM spécifié dans la connexion Amazon VPC pour se connecter à Amazon VPC.
Note
Si le rôle IAM par défaut ne dispose pas des autorisations requises par l'action, vous pouvez configurer l'action pour utiliser un autre rôle. Pour de plus amples informations, veuillez consulter Modifier le rôle IAM d'une action.
Pour plus d'informations sur les environnements, consultez Déploiement dans Comptes AWS et VPC etCréation d'un environnement.
Interface utilisateur correspondante : onglet Configuration/Environnement
Nom
(action-name/Environment/Name)
(Facultatif)
Spécifiez le nom d'un environnement existant que vous souhaitez associer à l'action.
Interface utilisateur correspondante : onglet Configuration/Environnement
Connexions
(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 à un compte :
-
L'action utilise la Compte AWS connexion et le rôle IAM 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 rôle IAM par défaut à l'environnement, consultezCréation d'un environnement.
-
Le rôle IAM 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 définition YAML de l'action.
Pour plus d'informations sur les connexions aux comptes, consultezPermettre l'accès à AWS ressources connectées Comptes AWS. Pour plus d'informations sur l'ajout d'une connexion de compte à un environnement, consultezCréation d'un environnement.
Interface utilisateur correspondante : tab/Environment Configuration/Qu'y a-t-il dedans ? my-environment /menu à trois points/ Changer de rôle
Nom
(action-name/Environment/Connections/Name)
(Obligatoire s'Connexionsil est inclus)
Spécifiez le nom de la connexion au compte.
Interface utilisateur correspondante : tab/Environment Configuration/Qu'y a-t-il dedans ? my-environment /menu à trois points/ Changer de rôle
Role
(action-name/Environment/Connections/Role)
(Obligatoire s'Connexionsil est inclus)
Spécifiez le nom du rôle IAM que cette action utilise pour accéder à des AWS services tels qu'Amazon S3 et Amazon ECR et y opérer. Assurez-vous que ce rôle est ajouté à votre Compte AWS connexion dans votre espace. Pour ajouter un rôle IAM à la connexion d'un compte, consultezAjout de rôles IAM à des connexions de compte.
Si vous ne spécifiez aucun rôle IAM, l'action utilise le rôle IAM par défaut répertorié dans l'environnement de la console. CodeCatalyst Si vous utilisez le rôle par défaut dans l'environnement, assurez-vous qu'il respecte les règles suivantes.
Note
Vous pouvez utiliser le CodeCatalystWorkflowDevelopmentRole- 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 spaceNameCodeCatalystWorkflowDevelopmentRole- 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 importante. spaceName
Avertissement
Limitez les autorisations à celles requises par les actions de génération et de test. L'utilisation d'un rôle avec des autorisations plus étendues peut présenter un risque de sécurité.
Interface utilisateur correspondante : tab/Environment Configuration/Qu'y a-t-il dedans ? my-environment /menu à trois points/ Changer de rôle
Mise en cache
(action-name/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 des fichiers - facultatif
FileCaching
(action-name/Caching/FileCaching)
(Facultatif)
Section qui spécifie la configuration d'une séquence de caches.
Interface utilisateur correspondante : mise en tab/File cache de la configuration - facultatif/Ajouter un cache
nom-clé-1
(action-name/Caching/FileCaching/key-name-1)
(Facultatif)
Spécifiez le nom de la propriété de votre cache principal. Les noms des propriétés du cache doivent être uniques au sein de votre flux de travail. Chaque action peut contenir jusqu'à cinq entréesFileCaching.
Interface utilisateur correspondante : mise en tab/File cache de configuration - optional/Add cache/ Key
Chemin
(action-name/Caching/FileCaching/key-name-1/Path)
(Facultatif)
Spécifiez le chemin associé à votre cache.
Interface utilisateur correspondante : mise en tab/File cache de configuration - optional/Add cache/ Path
RestoreKeys
(action-name/Caching/FileCaching/key-name-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 : mise en tab/File cache de la configuration - clés de optional/Add cache/de restauration - facultatif
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 de génération 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 des entrées secondaires utilisent un préfixe spécial pour les distinguer des entrées principales. Pour en savoir plus, 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 libellés 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 est stocké votre fichier de définition de flux de travail.
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 : aucune
Artefacts - entrée
(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 comme artefacts de sortie lors des 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 sous.action-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 Artefacts - optionnelle n'est pas disponible (éditeur visuel), ou si vous recevez des erreurs lorsque vous validez votre YAML (éditeur YAML), cela peut être dû au fait 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 - entrée
(action-name/Inputs/Variables)
(Facultatif)
Spécifiez une séquence de name/value paires 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, 0-9) A-Z, 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
Sorties
(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
Artefacts - sortie
(action-name/Outputs/Artifacts)
(Facultatif)
Spécifiez le nom d'un artefact généré par l'action. Les noms d'artefacts doivent être uniques au sein d'un flux de travail et se limitent 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
Nom
(action-name/Outputs/Artifacts/Name)
(Obligatoire s'Artefacts - sortieil est inclus)
Spécifiez le nom d'un artefact généré par l'action. Les noms d'artefacts doivent être uniques au sein d'un flux de travail et se limitent 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 : Sorties tab/Artifacts /Nouvelle sortie/Nom de l'artefact de création
Fichiers
(action-name/Outputs/Artifacts/Files)
(Obligatoire s'Artefacts - sortieil 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 lors de son exécution 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 provenant 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 spécifier des chemins. Exemples :
-
Pour spécifier un seul fichier qui se trouve à la racine de votre emplacement de génération ou de l'emplacement de votre référentiel source, utilisez
my-file.jar. -
Pour spécifier un seul fichier dans un sous-répertoire, utilisez
directory/my-file.jaroudirectory/subdirectory/my-file.jar. -
Pour spécifier tous les fichiers, utilisez
"**/*". Le modèle**global 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**global 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 pas aucun de ses sous-répertoires, utilisez"directory/*".
Note
Si le chemin de votre fichier comporte un ou plusieurs astérisques (*) ou un autre caractère spécial, placez-le entre guillemets doubles (). "" Pour plus d'informations sur les caractères spéciaux, consultezConventions et directives 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 quelle source le rechercher. 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 : Sorties tab/Artifacts /Nouvelle sortie/Fichiers produits par build
Variables - sortie
(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 : Sorties tab/Variables/Ajouter une variable
nom-de-variable-1
(action-name/Outputs/Variables/variable-name-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 : Sorties tab/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é, CodeCatalyst transformez-le 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 qui sont inspectés à l'aide ExcludePaths des propriétés IncludePaths ou.
Interface utilisateur correspondante : Sorties tab/Reports/Auto-discoverrapports
Activé
(action-name/Outputs/AutoDiscoverReports/Enabled)
(Facultatif)
Activez ou désactivez la fonctionnalité de découverte automatique.
Les valeurs valides sont true ou false.
Si cette valeur Enabled est omise, la valeur par défaut esttrue.
Interface utilisateur correspondante : Sorties tab/Reports/Auto-discoverrapports
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 qu'il trouve afin de nommer les rapports associés. CodeCatalyst Par exemple, si vous spécifiez un préfixe deAutoDiscovered, et CodeCatalyst que vous découvrez automatiquement deux rapports de testTestSuiteTwo.xml, les CodeCatalyst rapports associés seront nommés TestSuiteOne.xml AutoDiscoveredTestSuiteOne et. AutoDiscoveredTestSuiteTwo
Interface utilisateur correspondante : Sorties tab/Reports/Nom du préfixe
IncludePaths
(action-name/Outputs/AutoDiscoverReports/IncludePaths)
Or
(action-name/Outputs/Reports/report-name-1/IncludePaths)
(Obligatoire s'AutoDiscoverReportsil est inclus et activé, ou s'Rapportsil est inclus)
Spécifiez les fichiers et les chemins de fichiers à CodeCatalyst inclure lors de la recherche de rapports bruts. Par exemple, si vous spécifiez"/test/report/*", CodeCatalyst recherche l'intégralité de l'image de construction utilisée par l'action recherchant le /test/report/* répertoire. Lorsqu'il trouve ce répertoire, CodeCatalyst il recherche les rapports dans ce répertoire.
Note
Si le chemin de votre fichier comporte un ou plusieurs astérisques (*) ou d'autres caractères spéciaux, placez-le entre guillemets doubles (). "" Pour plus d'informations sur les caractères spéciaux, consultezConventions et directives 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 :
-
Sorties tab/Reports/Auto-discover reports/Include/exclure les chemins/ Inclure les chemins
-
Sorties tab/Reports /Configuration manuelle des rapports//
report-name-1chemins/ Inclure des Include/exclude chemins
ExcludePaths
(action-name/Outputs/AutoDiscoverReports/ExcludePaths)
Or
(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 spécifiez"/test/my-reports/**/*", les fichiers ne CodeCatalyst seront pas recherchés 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 d'autres caractères spéciaux, placez-le entre guillemets doubles (). "" Pour plus d'informations sur les caractères spéciaux, consultezConventions et directives de syntaxe.
Interface utilisateur correspondante :
-
Sorties tab/Reports/Auto-discover reports/Include/exclure les chemins/ Exclure les chemins
-
Sorties tab/Reports /Configuration manuelle des rapports//chemins/
report-name-1Exclure les Include/exclude chemins
SuccessCriteria
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria)
Or
(action-name/Outputs/Reports/report-name-1/SuccessCriteria)
(Facultatif)
Spécifiez les critères de réussite des rapports de test, de couverture de code, d'analyse de la composition logicielle (SCA) et d'analyse statique (SA).
Pour de plus amples informations, veuillez consulter Configuration des critères de réussite pour les rapports.
Interface utilisateur correspondante : critères de sortie tab/Reports/de réussite
PassRate
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/PassRate)
Or
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/PassRate)
(Facultatif)
Spécifiez le pourcentage de tests d'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 de taux de réussite ne sont appliqués qu'aux rapports de test. Pour plus d'informations sur les rapports de test, consultezRapports de test.
Interface utilisateur correspondante : tab/Reports sortie/Critères de succès/Taux de réussite
LineCoverage
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/LineCoverage)
Or
(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 réussi. Les valeurs valides incluent les nombres décimaux. Par exemple 50, 60.5. Les critères de couverture des lignes sont appliqués uniquement aux rapports de couverture de code. Pour plus d'informations sur les rapports de couverture de code, consultezRapports de couverture du code.
Interface utilisateur correspondante : tab/Reports sortie/Critères de succès/Couverture des lignes
BranchCoverage
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/BranchCoverage)
Or
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/BranchCoverage)
(Facultatif)
Spécifiez le pourcentage de branches d'un rapport de couverture de code qui doivent être couvertes 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 de couverture des branches sont appliqués uniquement aux rapports de couverture par code. Pour plus d'informations sur les rapports de couverture de code, consultezRapports de couverture du code.
Interface utilisateur correspondante : tab/Reports sortie/Critères de succès/Couverture des branches
Vulnérabilités
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/Vulnerabilities)
Or
(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 rapport SCA pour que le CodeCatalyst rapport associé soit marqué comme réussi. Pour spécifier 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
CRITICAL, sont :HIGH,MEDIUM,LOW,INFORMATIONAL.Par exemple, si vous le souhaitez
HIGH,HIGHlesCRITICALvulné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é sont appliqués uniquement aux rapports SCA. Pour plus d'informations sur les rapports SCA, consultezRapports d'analyse de la composition logicielle.
Pour spécifier la gravité minimale, utilisez la Severity propriété. Pour spécifier le nombre maximum de vulnérabilités, utilisez la Number propriété.
Interface utilisateur correspondante : résultats, critères tab/Reports de réussite, vulnérabilités
StaticAnalysisBug
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisBug)
Or
(action-name/Outputs/Reports/report-name-1/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 réussi. Pour spécifier des 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
CRITICAL, sont :HIGH,MEDIUM,LOW,INFORMATIONAL.Par exemple, si vous le souhaitez
HIGH,HIGHlesCRITICALbugs 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 d'ESLint SA. Pour plus d'informations sur les rapports SA, consultezRapports d'analyse statique.
Pour spécifier la gravité minimale, utilisez la Severity propriété. Pour spécifier le nombre maximum de vulnérabilités, utilisez la Number propriété.
Interface utilisateur correspondante : Sortie/Critères de tab/Reports succès/Bugs
StaticAnalysisSecurity
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisSecurity)
Or
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisSecurity)
(Facultatif)
Spécifiez le nombre maximum et la gravité des failles de sécurité autorisées dans le rapport SA pour que le CodeCatalyst rapport associé soit marqué comme réussi. Pour spécifier 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
CRITICAL, sont :HIGH,MEDIUM,LOW,INFORMATIONAL.Par exemple, si vous le souhaitez
HIGH,HIGHles faillesCRITICALde sécurité seront comptabilisées. -
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 sont appliqués qu'aux rapports PyLint d'ESLint SA. Pour plus d'informations sur les rapports SA, consultezRapports d'analyse statique.
Pour spécifier la gravité minimale, utilisez la Severity propriété. Pour spécifier le nombre maximum de vulnérabilités, utilisez la Number propriété.
Interface utilisateur correspondante : tab/Reports sortie/Critères de succès/Vulnérabilités de sécurité
StaticAnalysisQuality
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisQuality)
Or
(action-name/Outputs/Reports/report-name-1/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 spécifier 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
CRITICAL, sont :HIGH,MEDIUM,LOW,INFORMATIONAL.Par exemple, si vous le souhaitez
HIGH,HIGHles problèmesCRITICALde 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 sont appliqués qu' PyLint aux rapports d'ESLint SA. Pour plus d'informations sur les rapports SA, consultezRapports d'analyse statique.
Pour spécifier la gravité minimale, utilisez la Severity propriété. Pour spécifier le nombre maximum de vulnérabilités, utilisez la Number propriété.
Interface utilisateur correspondante : résultats, critères tab/Reports de réussite, problèmes de qualité
StaticAnalysisFinding
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisFinding)
Or
(action-name/Outputs/Reports/report-name-1/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 réussi. Pour spécifier les résultats, vous devez spécifier :
-
La sévérité 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
CRITICAL, sont :HIGH,MEDIUM,LOW,INFORMATIONAL.Par exemple, si vous le souhaitez
HIGH,HIGHlesCRITICALré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 sont appliqués uniquement aux rapports de la SARIF SA. Pour plus d'informations sur les rapports SA, consultezRapports d'analyse statique.
Pour spécifier la gravité minimale, utilisez la Severity propriété. Pour spécifier le nombre maximum de vulnérabilités, utilisez la Number propriété.
Interface utilisateur correspondante : résultats, critères tab/Reports de réussite, résultats
Rapports
(action-name/Outputs/Reports )
(Facultatif)
Section qui spécifie la configuration des rapports de test.
Interface utilisateur correspondante : onglet Sorties/Rapports
nom-rapport-1
(action-name/Outputs/Reports/nom-rapport-1)
(Obligatoire s'Rapportsil est inclus)
Le nom que vous souhaitez donner au CodeCatalyst rapport qui sera généré à partir de vos rapports bruts.
Interface utilisateur correspondante : Sorties tab/Reports /Configuration manuelle des rapports/Nom du rapport
Format
(action-name/Outputs/Reports/report-name-1/Format)
(Obligatoire s'Rapportsil 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 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 la composition logicielle (SCA) :
-
Pour SARIF, spécifiez SARIF (éditeur visuel) ou
SARIFSCA(éditeur YAML).
-
Interface utilisateur correspondante : Sorties tab/Reports /Configuration manuelle reports/Add /configuration des rapports/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
Conteneur
(action-name/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, celle-ci peut se trouver dans Amazon ECR, Docker Hub ou un autre registre. Si vous ne spécifiez pas d'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
Registre
(action-name/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é. Tout 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 doit accéder à Amazon ECR. Pour activer cet accès, vous devez créer un rôle IAM qui inclut les autorisations et la politique de confiance personnalisée suivantes. (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 :
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 que vous avez créé le rôle, vous devez l'attribuer à l'action via un environnement. Pour de plus amples informations, veuillez consulter Associer un environnement à une action.
-
Interface utilisateur correspondante : Amazon Elastic Container Registry, Docker Hub et autres options de registre
Image
(action-name/Configuration/Container/Image)
(Obligatoire s'Containeril est inclus)
Spécifiez l’un des éléments suivants :
-
Si vous utilisez un
CODECATALYSTregistre, 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, définissez l'image avec 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 un autre registre).
Étapes
(action-name/Configuration/Steps)
(Obligatoire)
Spécifiez les commandes shell que vous souhaitez exécuter lors de l'action pour installer, configurer et exécuter 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 spécification 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, consultez Référencement des fichiers du référentiel source etRéférencement de fichiers dans un artefact.
Interface utilisateur correspondante : onglet Configuration/commandes Shell
Colis
(action-name/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 packages logiciels dans CodeCatalyst.
Interface utilisateur correspondante : onglet Configuration/Packages
NpmConfiguration
(action-name/Configuration/Packages/NpmConfiguration)
(Obligatoire s'Colisil 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 : Configuration tab/Packages /Ajouter une configuration/ npm
PackageRegistries
(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries)
(Obligatoire s'Colisil 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 : Configuration tab/Packages configuration/npm /Ajouter/Ajouter un référentiel de packages
PackagesRepository
(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries/PackagesRepository)
(Obligatoire s'Colisil est inclus)
Spécifiez le nom du référentiel de CodeCatalyst packages que vous souhaitez que l'action utilise.
Si vous spécifiez plusieurs référentiels par défaut, le dernier dépôt sera prioritaire.
Pour plus d'informations sur les référentiels de packages, consultezRéférentiels de packages.
Interface utilisateur correspondante : Configuration tab/Packages /Ajouter /Ajouter un référentiel de configuration/npm paquets/Référentiel de packages
Portées
(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries/Scopes)
(Facultatif)
Spécifiez une séquence d'étendues 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 la portée est demandé via le client npm, il utilisera ce référentiel au lieu de celui par défaut. Chaque nom d'étendue doit être préfixé par « @ ».
Si vous incluez des étendues dérogatoires, le dernier référentiel sera prioritaire.
Si Scopes cette valeur est omise, 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 scopes, consultez Espaces de noms de packages Scoped packages.
Interface utilisateur correspondante : Configuration tab/Packages /Ajouter configuration/npm /Ajouter un référentiel de paquets/Scopes - facultatif
ExportAuthorizationToken
(action-name/Configuration/Packages/ExportAuthorizationToken)
(Facultatif)
Activez ou désactivez la fonctionnalité de jeton d'autorisation d'exportation. Si cette option est activée, les jetons d'autorisation exportés peuvent être utilisés pour configurer manuellement un gestionnaire de packages afin de s'authentifier auprès des référentiels de CodeCatalyst packages. Vous pouvez utiliser le jeton comme variable d'environnement pouvant être référencée dans vos actions.
Les valeurs valides sont true ou false.
Si cette valeur ExportAuthorizationToken est omise, la valeur par défaut estfalse.
Pour plus d'informations sur le jeton d'autorisation d'exportation, consultezUtilisation de jetons d'autorisation dans les actions du flux de travail.
Interface utilisateur correspondante : jeton d'autorisation de tab/Packages configuration/exportation