Exemples : déclencheurs dans les flux de travail

Les exemples suivants montrent comment ajouter différents types de déclencheurs dans un fichier de définition de CodeCatalyst flux de travail Amazon.

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

Exemple : un simple déclencheur push à code

L'exemple suivant montre un déclencheur qui lance l'exécution d'un flux de travail chaque fois que du code est envoyé à une branche de votre référentiel source.

Lorsque ce déclencheur est activé, CodeCatalyst lance un flux de travail exécuté à l'aide des fichiers de la branche vers laquelle vous pointez (c'est-à-dire la branche de destination).

Par exemple, si vous envoyez un commit àmain, CodeCatalyst lance un flux de travail exécuté à l'aide du fichier de définition du flux de travail et d'autres fichiers source. main

Autre exemple, si vous envoyez un commit àfeature-branch-123, CodeCatalyst lance un flux de travail exécuté à l'aide du fichier de définition du flux de travail et d'autres fichiers source. feature-branch-123

Triggers:
  - Type: PUSH

Note

Si vous souhaitez qu'un flux de travail ne démarre que lorsque vous appuyez dessusmain, consultezExemple : un simple déclencheur « push to main ».

Exemple : un simple déclencheur « push to main »

L'exemple suivant montre un déclencheur qui lance l'exécution d'un flux de travail chaque fois que du code est transmis à la main branche (et uniquement à la main branche) de votre référentiel source.

Triggers:
  - Type: PUSH
    Branches:
      - main

Exemple : un simple déclencheur de pull request

L'exemple suivant montre un déclencheur qui lance l'exécution d'un flux de travail chaque fois qu'une pull request est créée ou révisée dans votre référentiel source.

Lorsque ce déclencheur est activé, CodeCatalyst lance un flux de travail exécuté à l'aide du fichier de définition du flux de travail et des autres fichiers source de la branche d'où vous effectuez l'extraction (c'est-à-dire la branche source).

Par exemple, si vous créez une pull request avec une branche source appelée feature-123 et une branche de destination appeléemain, CodeCatalyst lance un flux de travail exécuté à l'aide du fichier de définition du flux de travail et d'autres fichiers source. feature-123

Triggers:
  - Type: PULLREQUEST
    Events:
      - OPEN
      - REVISION

Exemple : un simple déclencheur de planification

L'exemple suivant montre un déclencheur qui lance un flux de travail exécuté à minuit (UTC+0) du lundi au vendredi.

Lorsque ce déclencheur est activé, CodeCatalyst lance une seule exécution de flux de travail pour chaque branche de votre référentiel source contenant un fichier de définition de flux de travail avec ce déclencheur.

Par exemple, si votre référentiel source comporte trois branches,, main release-v1feature-123, et que chacune de ces branches contient un fichier de définition de flux de travail avec le déclencheur suivant, CodeCatalyst lance trois exécutions de flux de travail : une utilisant les fichiers dansmain, une autre utilisant les fichiers dans release-v1 et une autre utilisant les fichiers dansfeature-123.

Triggers:
  - Type: SCHEDULE
    Expression: "0 0 ? * MON-FRI *"

Pour plus d'exemples d'expressions cron que vous pouvez utiliser dans la Expression propriété, consultezExpression.

Exemple : un déclencheur avec un calendrier et des branches

L'exemple suivant montre un déclencheur qui lance un flux de travail exécuté à 18 h 15 (UTC+0) tous les jours.

Lorsque ce déclencheur est activé, CodeCatalyst lance un flux de travail à l'aide des fichiers de la main branche et lance des exécutions supplémentaires pour chaque branche commençant parrelease-.

Par exemple, si vous avez des branches nomméesmain, release-v1bugfix-1, bugfix-2 dans votre référentiel source, CodeCatalyst démarre deux exécutions de flux de travail : l'une utilisant les fichiers dansmain, l'autre utilisant les fichiers dansrelease-v1. Il ne lance pas les exécutions de flux de travail pour les bugfix-1 branches bugfix-1 et.

Triggers:
  - Type: SCHEDULE
    Expression: "15 18 * * ? *"
    Branches:
      - main
      - release\-.*

Pour plus d'exemples d'expressions cron que vous pouvez utiliser dans la Expression propriété, consultezExpression.

Exemple : un déclencheur avec un calendrier, un push et des branches

L'exemple suivant montre un déclencheur qui lance un flux de travail exécuté à minuit (UTC+0) tous les jours, et chaque fois que du code est envoyé à la main branche.

Dans cet exemple :

• L'exécution d'un flux de travail commence tous les jours à minuit. Le flux de travail exécuté utilise le fichier de définition du flux de travail et les autres fichiers source de la main branche.

• Un flux de travail démarre également chaque fois que vous envoyez un commit à la main branche. Le flux de travail exécuté utilise le fichier de définition du flux de travail et les autres fichiers source de la branche de destination (main).

Triggers:
  - Type: SCHEDULE
    Expression: "0 0 * * ? *"
    Branches:
      - main
  - Type: PUSH
    Branches: 
      - main

Pour plus d'exemples d'expressions cron que vous pouvez utiliser dans la Expression propriété, consultezExpression.

Exemple : une gâchette avec une traction et des branches

L'exemple suivant montre un déclencheur qui lance l'exécution d'un flux de travail chaque fois que quelqu'un ouvre ou modifie une pull request avec une branche de destination appeléemain. Bien que la branche spécifiée dans la Triggers configuration le soitmain, le flux de travail exécuté utilisera le fichier de définition du flux de travail et les autres fichiers source de la branche source (qui est la branche dont vous extrayez).

Triggers:      
  - Type: PULLREQUEST
    Branches:
      - main
    Events:
      - OPEN
      - REVISION

Exemple : un déclencheur avec un pull, des branches et un événement CLOSED « »

L'exemple suivant montre un déclencheur qui lance l'exécution d'un flux de travail chaque fois qu'une pull request est fermée sur une branche commençant parmain.

Dans cet exemple :

• Lorsque vous fermez une pull request dont la branche de destination commence parmain, l'exécution du flux de travail démarre automatiquement en utilisant le fichier de définition du flux de travail et les autres fichiers source de la branche source (désormais fermée).

• Si vous avez configuré votre dépôt source pour supprimer automatiquement les branches après la fusion d'une pull request, ces branches n'auront jamais la possibilité d'entrer dans l'CLOSEDétat. Cela signifie que les branches fusionnées n'activeront pas le CLOSED déclencheur de pull request. Dans ce scénario, le seul moyen d'activer le CLOSED déclencheur est de fermer la pull request sans la fusionner.

Triggers:     
  - Type: PULLREQUEST
    Branches:
      - main.*               
    Events:
      - CLOSED

Exemple : un déclencheur avec un push, des branches et des fichiers

L'exemple suivant montre un déclencheur qui lance l'exécution d'un flux de travail chaque fois qu'une modification est apportée au filename.txt fichier, ou à tout autre fichier du src répertoire, sur la main branche.

Lorsque ce déclencheur est activé, CodeCatalyst lance un flux de travail exécuté à l'aide du fichier de définition du flux de travail et des autres fichiers source de la main branche.

Triggers:
  - Type: PUSH
    Branches:
      - main
    FilesChanged:
      - filename.txt
      - src\/.*

Exemple : un déclencheur manuel

Pour configurer un déclencheur manuel, omettez la Triggers section dans le fichier de définition du flux de travail. Sans cette section, les utilisateurs sont obligés de démarrer le flux de travail manuellement en cliquant sur le bouton Exécuter de la CodeCatalyst console. Pour plus d’informations, consultez Démarrer un flux de travail exécuté manuellement.

Exemple : déclencheurs dans une configuration de flux de travail multiple CI/CD

Cet exemple décrit comment configurer des déclencheurs lorsque vous souhaitez utiliser des CodeCatalyst flux de travail Amazon distincts pour l'intégration continue (CI) et le déploiement continu (CD).

Dans ce scénario, vous configurez deux flux de travail :

• un flux de travail CI : ce flux de travail crée et teste votre application lorsqu'une pull request est créée ou révisée.

• un flux de travail sur CD : ce flux de travail crée et déploie votre application lorsqu'une pull request est fusionnée.

Le fichier de définition du flux de travail CI ressemblerait à ceci :

Triggers:      
  - Type: PULLREQUEST
    Branches:
      - main
    Events:
      - OPEN
      - REVISION
Actions:
  BuildAction:
    instructions-for-building-the-app
  TestAction:
    instructions-for-test-the-app

Le Triggers code indique de démarrer automatiquement un flux de travail chaque fois qu'un développeur de logiciel crée une pull request (ou en modifie une) demandant de fusionner sa branche de fonctionnalités avec la main branche. CodeCatalyst lance le flux de travail exécuté à l'aide du code source dans la branche source (qui est la branche des fonctionnalités).

Le fichier de définition du flux de travail du CD ressemblerait à ceci :

Triggers:      
  - Type: PUSH
    Branches:
      - main
Actions:
  BuildAction:
    instructions-for-building-the-app
  DeployAction:
    instructions-for-deploying-the-app

Le Triggers code indique de démarrer le flux de travail automatiquement lorsqu'une fusion a main lieu. CodeCatalyst lance l'exécution du flux de travail à l'aide du code source de la main branche.