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.

Définition YAML du flux de travail

Voici la documentation de référence pour le fichier de définition du flux de travail.

Un fichier de définition de flux de travail est un fichier YAML qui décrit votre flux de travail. Par défaut, le fichier est stocké dans un ~/.codecatalyst/workflows/ dossier à la racine de votre référentiel source. Le fichier peut avoir une extension .yml ou .yaml, et l'extension doit être en minuscules.

Pour créer et modifier le fichier de définition du flux de travail, vous pouvez utiliser un éditeur tel que vim, ou utiliser l'éditeur visuel ou l'éditeur YAML de la CodeCatalyst console. Pour de plus amples informations, veuillez consulter Utilisation des éditeurs visuels et YAML de la CodeCatalyst console.

Exemple de fichier de définition de flux de travail

Voici un exemple de fichier de définition de flux de travail simple. Il comprend quelques propriétés de niveau supérieur, une Triggers section et une Actions section comportant deux actions : Build etTest. Pour de plus amples informations, veuillez consulter À propos du fichier de définition du flux de travail.

Name: MyWorkflow
SchemaVersion: 1.0
RunMode: QUEUED
Triggers:
  - Type: PUSH
    Branches:
      - main
Actions:
  Build:
    Identifier: aws/build@v1
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:     
      Steps:
        - Run: docker build -t MyApp:latest .
  Test:
    Identifier: aws/managed-test@v1
    DependsOn: 
      - Build
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      Steps:
        - Run: npm install
        - Run: npm run test

Conventions et directives de syntaxe

Cette section décrit les règles de syntaxe du fichier de définition du flux de travail, ainsi que les conventions de dénomination utilisées dans cette documentation de référence.

Directives de syntaxe YAML

Le fichier de définition du flux de travail est écrit en YAML et suit la spécification YAML 1.1, de sorte que tout ce qui est autorisé dans cette spécification est également autorisé dans le flux de travail YAML. Si vous utilisez YAML pour la première fois, voici quelques instructions rapides pour vous assurer que vous fournissez un code YAML valide.

Convention d'appellation

Dans ce guide, nous utilisons les termes propriété et section pour désigner les principaux éléments d'un fichier de définition de flux de travail.

Top-level propriétés

Vous trouverez ci-dessous la documentation de référence pour les propriétés de niveau supérieur du fichier de définition du flux de travail.

# Name
Name: workflow-name
        
# Schema version
SchemaVersion: 1.0
        
# Run mode
RunMode: QUEUED|SUPERSEDED|PARALLEL

# Compute
Compute:  
...
            
# Triggers
Triggers:
...

# Actions
Actions:
...

Nom

(Obligatoire)

Nom du flux de travail. Le nom du flux de travail est affiché dans la liste des flux de travail et mentionné dans les notifications et les journaux. Le nom du flux de travail et le nom du fichier de définition du flux de travail peuvent correspondre, ou vous pouvez les nommer différemment. Les noms des flux de travail ne doivent pas nécessairement être uniques. Les noms des flux de travail 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 flux de travail.

Interface utilisateur correspondante : editor/Workflow propriétés visuelles/nom du flux de travail

SchemaVersion

(Obligatoire)

Version du schéma de la définition du flux de travail. Actuellement, la seule valeur valide est 1.0.

Interface utilisateur correspondante : aucune

RunMode

(Facultatif)

Comment CodeCatalyst gère plusieurs courses. Vous pouvez utiliser l'une des valeurs suivantes :

Si cette propriété est omise, la valeur par défaut estQUEUED.

Pour de plus amples informations, veuillez consulter Configuration du comportement de mise en file d'attente des exécutions.

Interface utilisateur correspondante : mode visuel editor/Workflow properties/Advanced/Exécution

Calcul

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

Pour plus d'informations sur le calcul, consultezConfiguration des images de calcul et d'exécution.

Interface utilisateur correspondante : aucune

Name: MyWorkflow
SchemaVersion: 1.0
...
Compute:  
  Type: EC2 | Lambda
  Fleet: fleet-name
  SharedInstance: true | false

Type

(Compute/Type)

(Obligatoire s'Computeil est défini)

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

Pour plus d’informations sur les types de calcul, consultez Types de calcul.

Interface utilisateur correspondante : visuel editor/Workflow properties/Advanced/type de calcul

Flotte

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

Pour plus d'informations sur les parcs informatiques, consultezFlottes informatiques.

Interface utilisateur correspondante : parc visuel editor/Workflow properties/Advanced/informatique

SharedInstance

(Compute/SharedInstance)

(Facultatif)

Spécifiez la capacité de partage de calcul pour vos actions. Avec le partage de calcul, les actions d'un flux de travail s'exécutent sur la même instance (image de l'environnement d'exécution). Vous pouvez utiliser l'une des valeurs suivantes :

Pour plus d'informations sur le partage de calcul, consultezPartage du calcul entre les actions.

Interface utilisateur correspondante : aucune

Triggers

(Facultatif)

Séquence d'un ou de plusieurs déclencheurs pour ce flux de travail. Si aucun déclencheur n'est spécifié, vous devez démarrer manuellement votre flux de travail.

Pour plus d'informations sur les déclencheurs, consultez Démarrage d'un flux de travail exécuté automatiquement à l'aide de déclencheurs.

Interface utilisateur correspondante : editor/workflow schéma visuel/déclencheurs

Name: MyWorkflow
SchemaVersion: 1.0
...
Triggers:
  - Type: PUSH
    Branches:
      - branch-name
    FilesChanged:
      - folder1/file
      - folder2/
 
  - Type: PULLREQUEST
    Events:
      - OPEN
      - CLOSED
      - REVISION
    Branches:
      - branch-name
    FilesChanged:
      - file1.txt
      
  - Type: SCHEDULE
    # Run the workflow at 10:15 am (UTC+0) every Saturday
    Expression: "15 10 ? * 7 *"
    Branches:
      - branch-name

Type

(Triggers/Type)

(Obligatoire s'Triggersil est défini)

Spécifiez le type de déclencheur. Vous pouvez utiliser l'une des valeurs suivantes :

Pour obtenir des exemples, consultez Exemples : déclencheurs dans les flux de travail.

Interface utilisateur correspondante : visuel editor/workflow diagram/Triggers/type de déclencheur

Événements

(Triggers/Events)

(Obligatoire si le déclencheur Type est réglé surPULLREQUEST)

Spécifiez le type d'événements de demande d'extraction qui lanceront l'exécution d'un flux de travail. Les valeurs valides sont les suivantes :

Vous pouvez spécifier plusieurs événements dans le même déclencheur de pull request.

Pour obtenir des exemples, consultez Exemples : déclencheurs dans les flux de travail.

Interface utilisateur correspondante : visuel editor/workflow diagram/Triggers/Événements pour la pull request

Branches

(Triggers/Branches)

(Facultatif)

Spécifiez les branches de votre référentiel source que le déclencheur surveille afin de savoir quand démarrer l'exécution d'un flux de travail. Vous pouvez utiliser des modèles regex pour définir les noms de vos branches. Par exemple, utilisez main.* pour faire correspondre toutes les branches commençant parmain.

Les branches à spécifier sont différentes selon le type de déclencheur :

Pour plus d'informations sur les branches et les déclencheurs, consultezDirectives d'utilisation pour les déclencheurs et les branches.

Pour obtenir plus d’exemples, consultez Exemples : déclencheurs dans les flux de travail.

Interface utilisateur correspondante : visuel editor/workflow diagram/Triggers/Branches

FilesChanged

(Triggers/FilesChanged)

(Facultatif si le déclencheur Type est réglé surPUSH, ouPULLREQUEST. Non pris en charge si le déclencheur Type est réglé surSCHEDULE.)

Spécifiez les fichiers ou dossiers de votre référentiel source que le déclencheur surveille afin de savoir quand démarrer l'exécution d'un flux de travail. Vous pouvez utiliser des expressions régulières pour faire correspondre les noms de fichiers ou les chemins.

Pour obtenir des exemples, consultez Exemples : déclencheurs dans les flux de travail.

Interface utilisateur correspondante : visuel editor/workflow diagram/Triggers/Fichiers modifiés

Expression

(Triggers/Expression)

(Obligatoire si le déclencheur Type est réglé surSCHEDULE)

Spécifiez l'expression cron qui décrit le moment où vous souhaitez que votre flux de travail planifié s'exécute.

Les expressions Cron CodeCatalyst utilisent la syntaxe à six champs suivante, où chaque champ est séparé par un espace :

minutes hours days-of-month month days-of-week year

Exemples d'expressions cron

Lorsque vous spécifiez des expressions cron dans CodeCatalyst, assurez-vous de suivre les instructions suivantes :

Pour plus d'exemples d'expressions cron et des informations sur les caractères génériques tels que?, et *L, consultez la référence relative aux expressions Cron dans le Guide de l'utilisateur Amazon EventBridge . Les expressions Cron entrent EventBridge et CodeCatalyst fonctionnent exactement de la même manière.

Pour des exemples de déclencheurs de planification, consultezExemples : déclencheurs dans les flux de travail.

Interface utilisateur correspondante : visuel editor/workflow diagram/Triggers/Calendrier

Actions

Séquence d'une ou de plusieurs actions pour ce flux de travail. CodeCatalyst prend en charge plusieurs types d'actions, tels que les actions de création et de test, qui offrent différents types de fonctionnalités. Chaque type d'action comporte :

Pour plus d'informations sur chaque type d'action, consultezTypes d'action. La Types d'action rubrique contient des liens vers la documentation de chaque action.

Voici la référence YAML pour les actions et les groupes d'actions dans le fichier de définition du flux de travail.

Name: MyWorkflow
SchemaVersion: 1.0
...
Actions:
  action-or-gate-name:
    Identifier: identifier
    Configuration:
    ...
  #Action groups
  action-group-name:
    Actions:
      ...

nom de l'action ou de la porte

(Actions/action-or-gate-name)

(Obligatoire)

action-nameRemplacez-le par le nom que vous souhaitez donner à l'action. Les noms des actions doivent être uniques dans le flux de travail et ne doivent inclure que des caractères alphanumériques, des traits d'union et des traits de soulignement. Pour plus d'informations sur les règles de syntaxe, consultezDirectives de syntaxe YAML.

Pour plus d'informations sur les pratiques de dénomination des actions, y compris les restrictions, consultez lenom de l'action ou de la porte.

Interface utilisateur correspondante : éditeur visuel/ /onglet action-name Configuration/ Nom de l'action ou nom d'affichage de l'action

nom du groupe d'action

(Actions/action-group-name)

(Facultatif)

Un groupe d'actions contient une ou plusieurs actions. Le regroupement des actions en groupes d'actions vous aide à organiser votre flux de travail et vous permet également de configurer les dépendances entre les différents groupes.

action-group-nameRemplacez-le par le nom que vous souhaitez donner au groupe d'actions. Les noms des groupes d'actions doivent être uniques au sein du flux de travail et ne doivent inclure que des caractères alphanumériques, des traits d'union et des traits de soulignement. Pour plus d'informations sur les règles de syntaxe, consultezDirectives de syntaxe YAML.

Pour plus d'informations sur les groupes d'action, consultezRegrouper les actions en groupes d'actions.

Interface utilisateur correspondante : aucune