Utilisation de variables prédéfinies

Les variables prédéfinies sont des paires clé-valeur émises automatiquement par un flux de travail et mises à votre disposition pour que vous puissiez les utiliser dans des actions de flux de travail.

Vous pouvez utiliser des variables prédéfinies dans n'importe quelle action du flux de travail.

Référencer une variable prédéfinie

Suivez les instructions ci-dessous pour référencer une variable prédéfinie.

Prérequis

Déterminez le nom de la variable prédéfinie à laquelle vous souhaitez faire référence, par exempleCommitId. Pour plus d’informations, consultez Déterminer les variables prédéfinies émises par votre flux de travail.

Visual

Non disponible. Choisissez YAML pour afficher les instructions YAML.

YAML

Pour référencer une variable prédéfinie (éditeur YAML)

1. Ouvrez la CodeCatalyst console à l'adresse https://codecatalyst.aws/.

2. Choisissez votre projet.

3. Dans le volet de navigation, choisissez CI/CD, puis Workflows.

4. Choisissez le nom de votre flux de travail. Vous pouvez filtrer par le nom du référentiel source ou de la branche où le flux de travail est défini, ou filtrer par nom de flux de travail.

5. Choisissez Modifier.

6. Choisissez YAML.

7. Dans une CodeCatalyst action, ajoutez la référence de variable prédéfinie en utilisant la syntaxe suivante :

   ${action-group-name.action-name-or-WorkflowSource.variable-name}

   Remplacer :

   • action-group-nameavec le nom du groupe d'action.

     Note

     Vous pouvez omettre action-group-names'il n'existe aucun groupe d'actions ou si la variable est produite par une action du même groupe d'actions.

   • action-name-or- WorkflowSource avec :

     Nom de l'action qui génère la variable.

     or

     WorkflowSource, si la variable est la CommitId variable BranchName ou.

   • variable-name avec le nom de la variable.

   Par exemple :

   MySecondAction:
       Configuration:
         Steps:
           - Run: echo ${MyFirstECSAction.cluster}

   Voici un autre exemple  :

   MySecondAction:
       Configuration:
         Steps:
           - Run: echo ${WorkflowSource.CommitId}

   Pour obtenir plus d’exemples, consultez Exemples de variables prédéfinies. Pour plus d'informations, consultez le Définition du flux de travail YAML correspondant à votre action.

8. (Facultatif) Choisissez Valider pour valider le code YAML du flux de travail avant de le valider.

9. Choisissez Valider, entrez un message de validation, puis choisissez à nouveau Valider.

Déterminer les variables prédéfinies émises par votre flux de travail

Vous pouvez déterminer les variables prédéfinies émises par votre flux de travail de deux manières :

• Exécutez le flux de travail une seule fois. Une fois l'exécution terminée, les variables émises par le flux de travail sont affichées dans l'onglet Variables de la page des détails de l'exécution. Pour plus d’informations, consultez Afficher le statut et les détails de l'exécution du flux de travail.

• Consultez le Liste des variables prédéfinies. Cette référence répertorie le nom (clé) et la valeur de chaque variable prédéfinie.

Note

La taille totale maximale des variables d'un flux de travail est répertoriée dansQuotas pour les workflows. Si la taille totale dépasse le maximum, l'action qui se produit une fois le maximum atteint peut échouer.

Exemples de variables prédéfinies

Les exemples suivants montrent comment référencer des variables prédéfinies dans le fichier de définition du flux de travail.

Exemples

• Exemple : Référencement de la variable prédéfinie CommitId « »
• Exemple : Référencement de la variable prédéfinie BranchName « »

Exemple : Référencement de la variable prédéfinie CommitId « »

L'exemple suivant montre comment faire référence à la variable CommitId prédéfinie dans l'MyBuildActionaction. La CommitId variable est sortie automatiquement par CodeCatalyst.

Bien que l'exemple montre la variable utilisée dans l'action de génération, vous pouvez l'utiliser CommitId dans n'importe quelle action.

MyBuildAction:
    Identifier: aws/build@v1
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      Steps:
      #Build Docker image and tag it with a commit ID
        - Run: docker build -t image-repo/my-docker-image:latest .
        - Run: docker tag image-repo/my-docker-image:${WorkflowSource.CommitId}

Exemple : Référencement de la variable prédéfinie BranchName « »

L'exemple suivant montre comment faire référence à la variable BranchName prédéfinie dans l'CDKDeployaction. La BranchName variable est sortie automatiquement par CodeCatalyst.

Bien que l'exemple montre la variable utilisée dans l'action de AWS CDK déploiement, vous pouvez l'utiliser BranchName dans n'importe quelle action.

CDKDeploy:
    Identifier: aws/cdk-deploy@v1
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      StackName: app-stack-${WorkflowSource.BranchName}