Ajouter des déclencheurs aux flux de travail - Amazon 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.

Ajouter des déclencheurs aux flux de travail

Suivez les instructions suivantes pour ajouter un déclencheur push, pull ou de planification à votre 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.

Visual
Pour ajouter un déclencheur (éditeur visuel)

  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 ou statut du flux de travail.

  5. Choisissez Modifier.

  6. Choisissez Visual.

  7. Dans le diagramme du flux de travail, sélectionnez la case Source et déclencheurs.

  8. Dans le volet de configuration, choisissez Ajouter un déclencheur.

  9. Dans la boîte de dialogue Ajouter un déclencheur, entrez les informations dans les champs, comme suit.

    Type de déclencheur

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

    • Push (éditeur visuel) ou PUSH (YAMLéditeur)

      Un déclencheur push lance l'exécution d'un flux de travail lorsqu'une modification est transmise à votre référentiel source. Le flux de travail exécuté utilisera les fichiers de la branche vers laquelle vous transférez (c'est-à-dire la branche de destination).

    • Pull request (éditeur visuel) ou PULLREQUEST (YAMLéditeur)

      Un déclencheur de pull request lance un flux de travail lorsqu'une pull request est ouverte, mise à jour ou fermée dans votre référentiel source. Le flux de travail exécuté utilisera les fichiers de la branche d'où vous les extrayez (c'est-à-dire la branche source).

    • Calendrier (éditeur visuel) ou SCHEDULE (YAMLéditeur)

      Un déclencheur de planification lance des exécutions de flux de travail selon un calendrier défini par une expression cron que vous spécifiez. Un flux de travail distinct démarrera pour chaque branche de votre référentiel source à l'aide des fichiers de la branche. (Pour limiter le nombre de branches sur lesquelles le déclencheur est activé, utilisez le champ Branches (éditeur visuel) ou la Branches propriété (YAMLéditeur).)

      Lorsque vous configurez un déclencheur de planification, suivez les instructions suivantes :

      • N'utilisez qu'un seul déclencheur de planification par flux de travail.

      • Si vous avez défini plusieurs flux de travail dans votre CodeCatalyst espace, nous vous recommandons de ne pas en planifier plus de 10 pour qu'ils démarrent simultanément.

      • Assurez-vous de configurer l'expression cron du déclencheur avec un délai suffisant entre les exécutions. Pour plus d’informations, consultez Expression.

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

    Événements pour la pull request

    Ce champ n'apparaît que si vous avez sélectionné le type de déclencheur de demande Pull.

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

    • Une pull request est créée (éditeur visuel) ou OPEN (YAMLéditeur)

      L'exécution du flux de travail démarre lorsqu'une pull request est créée.

    • La pull request est fermée (éditeur visuel) ou CLOSED (YAMLéditeur)

      L'exécution du flux de travail démarre lorsqu'une pull request est fermée. Le comportement de l'CLOSEDévénement est délicat et il est préférable de le comprendre à l'aide d'un exemple. Pour plus d’informations, consultez Exemple : un déclencheur avec un pull, des branches et un événement CLOSED « ».

    • Une nouvelle révision est effectuée sur pull request (éditeur visuel) ou REVISION (YAMLéditeur)

      L'exécution du flux de travail démarre lorsqu'une révision d'une pull request est créée. La première révision est créée lors de la création de la pull request. Ensuite, une nouvelle révision est créée chaque fois que quelqu'un envoie un nouveau commit vers la branche source spécifiée dans la pull request. Si vous incluez l'REVISIONévénement dans votre déclencheur de pull request, vous pouvez l'OPENomettre, car il s'REVISIONagit d'un sur-ensemble de. OPEN

    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.

    Schedule

    Ce champ n'apparaît que si vous avez sélectionné le type de déclencheur Schedule.

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

    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

    Minutes Heures Jours du mois Mois Jours de la semaine Année Signification

    0

    0

    ?

    *

    MON-FRI

    *

    Exécute un flux de travail à minuit (UTC+0) du lundi au vendredi.

    0

    2

    *

    *

    ?

    *

    Exécute un flux de travail à 2 h 00 (UTC+0) tous les jours.

    15

    22

    *

    *

    ?

    *

    Exécute un flux de travail à 22 h 15 (UTC+0) tous les jours.

    0/30

    22-2

    ?

    *

    SAT-SUN

    *

    Exécute un flux de travail toutes les 30 minutes du samedi au dimanche entre 22 h 00 le jour de départ et 2 h 00 le jour suivant (UTC+0).

    45

    13

    L

    *

    ?

    2023-2027

    Exécute un flux de travail à 13 h 45 (UTC+0) le dernier jour du mois entre 2023 et 2027 inclus.

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

    • Spécifiez une seule expression cron par SCHEDULE déclencheur.

    • Mettez l'expression cron entre guillemets (") dans l'éditeur. YAML

    • Spécifiez l'heure en temps universel coordonné (UTC). Les autres fuseaux horaires ne sont pas pris en charge.

    • Configurez au moins 30 minutes entre les exécutions. Une cadence plus rapide n'est pas prise en charge.

    • Spécifiez le days-of-month or days-of-week terrain, mais pas les deux. Si vous spécifiez une valeur ou un astérisque (*) dans l'un des champs, vous devez utiliser un point d'interrogation (?) dans l'autre. L'astérisque signifie « tout » et le point d'interrogation signifie « tout ».

    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 des 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, voirExemples : déclencheurs dans les flux de travail.

    Branches et modèle de branches

    (Facultatif)

    Spécifiez les branches de votre référentiel source que le déclencheur surveille afin de savoir quand démarrer une exécution de 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 un déclencheur, spécifiez les branches vers lesquelles vous poussez, c'est-à-dire les branches de destination. Une exécution de flux de travail démarrera par branche correspondante, en utilisant les fichiers de la branche correspondante.

      Exemples : main.*, mainline

    • Pour un déclencheur de pull request, spécifiez les branches vers lesquelles vous pointez, c'est-à-dire les branches de destination. Une exécution de flux de travail démarrera par branche correspondante, en utilisant le fichier de définition du flux de travail et les fichiers source de la branche source (et non de la branche correspondante).

      Exemples :main.*,mainline, v1\-.* (correspond aux branches commençant parv1-)

    • Pour un déclencheur de planification, spécifiez les branches contenant les fichiers que vous souhaitez que votre exécution planifiée utilise. Une exécution de flux de travail démarrera par branche correspondante, en utilisant le fichier de définition du flux de travail et les fichiers source de la branche correspondante.

      Exemples : main.*, version\-1\.0

    Note

    Si vous ne spécifiez pas de branches, le déclencheur surveille toutes les branches de votre référentiel source et lancera l'exécution d'un flux de travail à l'aide du fichier de définition du flux de travail et des fichiers source dans :

    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.

    Fichiers modifiés

    Ce champ n'apparaît que si vous avez sélectionné le type de déclencheur de demande Push ou Pull.

    Spécifiez les fichiers ou les dossiers de votre référentiel source que le déclencheur surveille afin de savoir quand démarrer une exécution de 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.

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

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

YAML
Pour ajouter un déclencheur (YAMLéditeur)

  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 ou statut du flux de travail.

  5. Choisissez Modifier.

  6. Choisissez YAML.

  7. Ajoutez une Triggers section et les propriétés sous-jacentes en utilisant l'exemple suivant comme guide. Pour en savoir plus, consultez Triggers dans la rubrique YAMLDéfinition du flux de travail.

    Un déclencheur de code push peut ressembler à ceci :

    Triggers:
  - Type: PUSH
    Branches:
      - main

    Un déclencheur de pull request peut ressembler à ceci :

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

    Un déclencheur de planification peut ressembler à ceci :

    Triggers:
  - Type: SCHEDULE
    Branches:
      - main.*
    # Run the workflow at 1:15 am (UTC+0) every Friday until the end of 2023
    Expression: "15 1 ? * FRI 2022-2023"

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

    Pour plus d'exemples de déclencheurs push, pull request et schedule, consultezExemples : déclencheurs dans les flux de travail.

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

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