Hinzufügen von Triggern zu Workflows - Amazon CodeCatalyst

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Hinzufügen von Triggern zu Workflows

Verwenden Sie die folgenden Anweisungen, um Ihrem CodeCatalyst Amazon-Workflow einen Push-, Pull- oder Schedule-Trigger hinzuzufügen.

Weitere Informationen zu Auslösern finden Sie unter Automatisches Starten einer Workflow-Ausführung mithilfe von Triggern.

Visual
Um einen Trigger hinzuzufügen (visueller Editor)

  1. Öffnen Sie die CodeCatalyst Konsole unter https://codecatalyst.aws/.

  2. Wählen Sie Ihr Projekt.

  3. Wählen Sie im Navigationsbereich CI/CD und dann Workflows aus.

  4. Wählen Sie den Namen Ihres Workflows. Sie können nach dem Quell-Repository oder dem Branch-Namen filtern, in dem der Workflow definiert ist, oder nach Workflow-Namen oder -Status filtern.

  5. Wählen Sie Bearbeiten aus.

  6. Wählen Sie Visual.

  7. Wählen Sie im Workflow-Diagramm das Feld Quelle und Auslöser aus.

  8. Wählen Sie im Konfigurationsbereich die Option Trigger hinzufügen aus.

  9. Geben Sie im Dialogfeld „Trigger hinzufügen“ die folgenden Informationen in die Felder ein.

    Typ des Triggers

    Geben Sie den Triggertyp an. Sie können einen der folgenden Werte verwenden:

    • Drücken Sie (visueller Editor) oder PUSH (YAMLEditor)

      Ein Push-Trigger startet einen Workflow-Lauf, wenn eine Änderung in Ihr Quell-Repository übertragen wird. Bei der Workflow-Ausführung werden die Dateien in dem Branch verwendet, in den Sie pushen (das ist der Ziel-Branch).

    • Pull-Request (visueller Editor) oder PULLREQUEST (YAMLEditor)

      Ein Pull-Request-Trigger startet einen Workflow-Lauf, wenn ein Pull-Request in Ihrem Quell-Repository geöffnet, aktualisiert oder geschlossen wird. Bei der Workflow-Ausführung werden die Dateien in dem Branch verwendet, aus dem Sie abrufen (das ist der Quell-Branch).

    • Zeitplan (visueller Editor) oder SCHEDULE (YAMLEditor)

      Ein Zeitplan-Trigger startet Workflow-Läufe nach einem Zeitplan, der durch einen von Ihnen angegebenen Cron-Ausdruck definiert wird. Für jeden Branch in Ihrem Quell-Repository wird ein separater Workflow-Lauf gestartet, der die Dateien des Branches verwendet. (Verwenden Sie das Feld Branches (visueller Editor) oder die Branches Eigenschaft (YAMLEditor), um die Branches einzuschränken, für die der Trigger aktiviert wird.)

      Beachten Sie bei der Konfiguration eines Zeitplan-Triggers die folgenden Richtlinien:

      • Verwenden Sie nur einen Zeitplan-Trigger pro Workflow.

      • Wenn Sie in Ihrem CodeCatalyst Bereich mehrere Workflows definiert haben, empfehlen wir, nicht mehr als 10 davon so zu planen, dass sie gleichzeitig starten.

      • Stellen Sie sicher, dass Sie den Cron-Ausdruck des Triggers so konfigurieren, dass genügend Zeit zwischen den Läufen liegt. Weitere Informationen finden Sie unter Expression.

    Beispiele finden Sie unter Beispiele: Trigger in Workflows.

    Ereignisse für Pull-Requests

    Dieses Feld wird nur angezeigt, wenn Sie den Triggertyp Pull-Request ausgewählt haben.

    Geben Sie den Typ der Pull-Request-Ereignisse an, mit denen eine Workflow-Ausführung gestartet wird. Die folgenden Werte sind gültig:

    • Eine Pull-Anfrage wird erstellt (visueller Editor) oder OPEN (YAMLEditor)

      Der Workflow-Lauf wird gestartet, wenn ein Pull-Request erstellt wird.

    • Der Pull-Request ist geschlossen (Visual Editor) oder CLOSED (YAMLEditor)

      Der Workflow-Lauf wird gestartet, wenn ein Pull-Request geschlossen wird. Das Verhalten des CLOSED Ereignisses ist knifflig und lässt sich am besten anhand eines Beispiels verstehen. Weitere Informationen finden Sie unter Beispiel: Ein Trigger mit einem Pull, Branches und einem Ereignis CLOSED ''.

    • Eine neue Version wird per Pull-Request (visueller Editor) oder REVISION (YAMLEditor) erstellt

      Der Workflow-Lauf wird gestartet, wenn eine Revision eines Pull-Requests erstellt wird. Die erste Revision wird erstellt, wenn der Pull-Request erstellt wird. Danach wird jedes Mal, wenn jemand einen neuen Commit an den im Pull Request angegebenen Quell-Branch pusht, eine neue Revision erstellt. Wenn Sie das REVISION Ereignis in Ihren Pull-Request-Trigger aufnehmen, können Sie das OPEN Ereignis weglassen, da es eine Obermenge von REVISION ist. OPEN

    Sie können mehrere Ereignisse in demselben Pull-Request-Trigger angeben.

    Beispiele finden Sie unter Beispiele: Trigger in Workflows.

    Plan

    Dieses Feld wird nur angezeigt, wenn Sie den Triggertyp „Zeitplan“ ausgewählt haben.

    Geben Sie den Cron-Ausdruck an, der beschreibt, wann Ihre geplanten Workflow-Ausführungen ausgeführt werden sollen.

    In Cron-Ausdrücken wird die folgende Syntax mit sechs Feldern CodeCatalyst verwendet, wobei jedes Feld durch ein Leerzeichen getrennt ist:

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

    Beispiele für Cron-Ausdrücke

    Minuten Stunden Tage des Monats Monat Wochentage Jahr Bedeutung

    0

    0

    ?

    *

    MON-FRI

    *

    Führt jeden Montag bis Freitag um Mitternacht (UTC+0) einen Workflow aus.

    0

    2

    *

    *

    ?

    *

    Führt jeden Tag um 2:00 Uhr (UTC+0) einen Workflow aus.

    15

    22

    *

    *

    ?

    *

    Führt jeden Tag um 22:15 Uhr (UTC+0) einen Workflow aus.

    0/30

    22-2

    ?

    *

    SAT-SUN

    *

    Führt samstags bis sonntags alle 30 Minuten einen Workflow zwischen 22:00 Uhr am Starttag und 2:00 Uhr am Folgetag aus (UTC+0).

    45

    13

    L

    *

    ?

    2023-2027

    Führt am letzten Tag des Monats zwischen 2023 und einschließlich 2027 um 13:45 Uhr (UTC+0) einen Workflow aus.

    Achten Sie bei der Angabe von Cron-Ausdrücken in darauf CodeCatalyst, dass Sie die folgenden Richtlinien beachten:

    • Geben Sie einen einzelnen Cron-Ausdruck pro SCHEDULE Trigger an.

    • Schließen Sie den Cron-Ausdruck im Editor in doppelte Anführungszeichen (") ein. YAML

    • Geben Sie die Uhrzeit in Coordinated Universal Time () an. UTC Andere Zeitzonen werden nicht unterstützt.

    • Konfigurieren Sie mindestens 30 Minuten zwischen den Läufen. Eine schnellere Trittfrequenz wird nicht unterstützt.

    • Geben Sie die an days-of-month or days-of-week Feld, aber nicht beide. Wenn Sie in einem der Felder einen Wert oder ein Sternchen (*) angeben, müssen Sie in dem anderen Feld ein Fragezeichen (?) verwenden. Das Sternchen bedeutet „alle“ und das Fragezeichen bedeutet „beliebig“.

    Weitere Beispiele für Cron-Ausdrücke und Informationen zu Platzhaltern wie ? *L, und finden Sie in der Referenz zu Cron-Ausdrücken im EventBridge Amazon-Benutzerhandbuch. Cron-Ausdrücke in EventBridge und CodeCatalyst funktionieren genauso.

    Beispiele für Zeitplan-Trigger finden Sie unterBeispiele: Trigger in Workflows.

    Zweige und Filialmuster

    (Optional)

    Geben Sie die Branches in Ihrem Quell-Repository an, die der Trigger überwacht, um zu wissen, wann ein Workflow-Lauf gestartet werden muss. Sie können Regex-Muster verwenden, um Ihre Branch-Namen zu definieren. Verwenden Sie dies beispielsweise, um alle Zweige main.* abzugleichen, die mit beginnen. main

    Die anzugebenden Zweige unterscheiden sich je nach Triggertyp:

    • Geben Sie für einen Push-Trigger die Zweige an, auf die Sie pushen möchten, d. h. die Zielzweige. Pro übereinstimmender Verzweigung wird ein Workflow-Lauf gestartet, wobei die Dateien im entsprechenden Zweig verwendet werden.

      Beispiele: main.*, mainline

    • Geben Sie für einen Pull-Request-Trigger die Branches an, in die Sie pushen möchten, also die Ziel-Branches. Pro zugeordnetem Branch wird ein Workflow-Lauf gestartet, wobei die Workflow-Definitionsdatei und die Quelldateien im Quellzweig (nicht im passenden Branch) verwendet werden.

      Beispiele:main.*,mainline, v1\-.* (entspricht Verzweigungen, die mit beginnenv1-)

    • Geben Sie für einen Zeitplan-Trigger die Zweige an, die die Dateien enthalten, die bei Ihrem geplanten Lauf verwendet werden sollen. Pro zugeordnetem Zweig wird ein Workflow-Lauf gestartet, wobei die Workflow-Definitionsdatei und die Quelldateien im entsprechenden Zweig verwendet werden.

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

    Anmerkung

    Wenn Sie keine Verzweigungen angeben, überwacht der Trigger alle Zweige in Ihrem Quell-Repository und startet eine Workflow-Ausführung mit der Workflow-Definitionsdatei und den Quelldateien in:

    Weitere Informationen zu Branches und Triggern finden Sie unterRichtlinien zur Verwendung von Triggern und Branches.

    Weitere Beispiele finden Sie unter Beispiele: Trigger in Workflows.

    Dateien wurden geändert

    Dieses Feld wird nur angezeigt, wenn Sie den Triggertyp Push - oder Pull-Anfrage ausgewählt haben.

    Geben Sie die Dateien oder Ordner in Ihrem Quell-Repository an, die der Trigger überwacht, damit Sie wissen, wann eine Workflow-Ausführung gestartet werden muss. Sie können reguläre Ausdrücke verwenden, um Dateinamen oder Pfade abzugleichen.

    Beispiele finden Sie unter Beispiele: Trigger in Workflows.

  10. (Optional) Wählen Sie „Validieren“, um den YAML Workflow-Code vor dem Commit zu überprüfen.

  11. Wählen Sie Commit, geben Sie eine Commit-Nachricht ein und wählen Sie erneut Commit.

YAML
Um einen Trigger hinzuzufügen (YAMLEditor)

  1. Öffnen Sie die CodeCatalyst Konsole unter https://codecatalyst.aws/.

  2. Wählen Sie Ihr Projekt.

  3. Wählen Sie im Navigationsbereich CI/CD und dann Workflows aus.

  4. Wählen Sie den Namen Ihres Workflows. Sie können nach dem Quell-Repository oder dem Branch-Namen filtern, in dem der Workflow definiert ist, oder nach Workflow-Namen oder -Status filtern.

  5. Wählen Sie Bearbeiten aus.

  6. Wählen Sie YAML.

  7. Fügen Sie anhand des folgenden Beispiels einen Triggers Abschnitt und die zugrunde liegenden Eigenschaften hinzu. Weitere Informationen finden Sie unter Triggers im YAMLWorkflow-Definition.

    Ein Code-Push-Trigger könnte so aussehen:

    Triggers:
  - Type: PUSH
    Branches:
      - main

    Ein Pull-Request-Trigger könnte so aussehen:

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

    Ein Zeitplan-Trigger könnte wie folgt aussehen:

    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"

    Weitere Beispiele für Cron-Ausdrücke, die Sie in der Expression Eigenschaft verwenden können, finden Sie unterExpression.

    Weitere Beispiele für Push-, Pull-Request- und Schedule-Trigger finden Sie unterBeispiele: Trigger in Workflows.

  8. (Optional) Wählen Sie „Validieren“, um den YAML Workflow-Code vor dem Commit zu überprüfen.

  9. Wählen Sie Commit, geben Sie eine Commit-Nachricht ein und wählen Sie erneut Commit.