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.

YAMLWorkflow-Definition

Im Folgenden finden Sie die Referenzdokumentation für die Workflow-Definitionsdatei.

Eine Workflow-Definitionsdatei ist eine YAML Datei, die Ihren Workflow beschreibt. Standardmäßig wird die Datei in einem ~/.codecatalyst/workflows/ Ordner im Stammverzeichnis Ihres Quell-Repositorys gespeichert. Die Datei kann die Erweiterung „.yml“ oder „.yaml“ haben, und die Erweiterung muss in Kleinbuchstaben geschrieben werden.

Um die Workflow-Definitionsdatei zu erstellen und zu bearbeiten, können Sie einen Editor wie vim oder den visuellen Editor oder Editor der CodeCatalyst Konsole verwenden. YAML Weitere Informationen finden Sie unter Verwenden der visuellen Elemente und YAML Editoren der CodeCatalyst Konsole.

Beispiel für eine Workflow-Definitionsdatei

Im Folgenden finden Sie ein Beispiel für eine einfache Workflow-Definitionsdatei. Sie umfasst einige Eigenschaften der obersten Ebene, einen Triggers Abschnitt und einen Actions Abschnitt mit zwei Aktionen: Build undTest. Weitere Informationen finden Sie unter Informationen zur Workflow-Definitionsdatei.

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

Richtlinien und Konventionen zur Syntax

In diesem Abschnitt werden die Syntaxregeln für die Workflow-Definitionsdatei sowie die in dieser Referenzdokumentation verwendeten Namenskonventionen beschrieben.

YAMLRichtlinien für die Syntax

Die Workflow-Definitionsdatei ist in der YAML1.1-Spezifikation geschrieben YAML und folgt ihr, sodass alles, was in dieser Spezifikation zulässig ist, auch im Workflow zulässig istYAML. Wenn Sie noch nicht damit vertraut sindYAML, finden Sie hier einige kurze Richtlinien, um sicherzustellen, dass Sie gültigen YAML Code angeben.

Namenskonventionen

In diesem Handbuch beziehen wir uns mit den Begriffen Eigenschaft und Abschnitt auf die wichtigsten Elemente in einer Workflow-Definitionsdatei.

Eigenschaften der obersten Ebene

Im Folgenden finden Sie die Referenzdokumentation für die Eigenschaften der obersten Ebene in der Workflow-Definitionsdatei.

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

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

# Actions
Actions:
...

Name

(Erforderlich)

Der Name des Workflows. Der Workflow-Name wird in der Workflow-Liste angezeigt und in Benachrichtigungen und Protokollen erwähnt. Der Workflowname und der Name der Workflow-Definitionsdatei können übereinstimmen, oder Sie können sie unterschiedlich benennen. Workflow-Namen müssen nicht eindeutig sein. Workflow-Namen sind auf alphanumerische Zeichen (a-z, A-Z, 0-9), Bindestriche (-) und Unterstriche (_) beschränkt. Leerzeichen sind nicht erlaubt. Sie können keine Anführungszeichen verwenden, um Sonderzeichen und Leerzeichen in Workflow-Namen zuzulassen.

Entsprechende Benutzeroberfläche: visueller Editor/Workflow-Eigenschaften/Workflow-Name

SchemaVersion

(Erforderlich)

Die Schemaversion der Workflow-Definition. Der einzige gültige Wert ist derzeit 1.0.

Entsprechende Benutzeroberfläche: keine

RunMode

(Optional)

Wie CodeCatalyst geht man mit mehreren Durchläufen um? Sie können einen der folgenden Werte verwenden:

Wenn diese Eigenschaft weggelassen wird, ist die StandardeinstellungQUEUED.

Weitere Informationen finden Sie unter Konfiguration des Warteschlangenverhaltens von Läufen.

Entsprechende Benutzeroberfläche: Visual Editor/Workflow-Eigenschaften/Erweitert/Ausführungsmodus

Compute

(Optional)

Die Rechen-Engine, mit der Ihre Workflow-Aktionen ausgeführt wurden. Sie können die Berechnung entweder auf Workflow-Ebene oder auf Aktionsebene angeben, aber nicht beide. Wenn auf Workflow-Ebene angegeben, gilt die Rechenkonfiguration für alle im Workflow definierten Aktionen. Auf Workflow-Ebene können Sie auch mehrere Aktionen auf derselben Instanz ausführen. Weitere Informationen finden Sie unter Rechenleistung für mehrere Aktionen gemeinsam nutzen.

Weitere Informationen zu Compute finden Sie unterKonfiguration von Compute- und Runtime-Images.

Entsprechende Benutzeroberfläche: keine

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

Type

(Compute/Type)

(Erforderlich, Compute wenn gesetzt)

Der Typ der Compute Engine. Sie können einen der folgenden Werte verwenden:

Weitere Informationen zu Datentypen finden Sie unter Berechnungstypen.

Entsprechende Benutzeroberfläche: Visual Editor/Workflow-Eigenschaften/Erweitert/Berechnungstyp

Fleet

(Compute/Fleet)

(Optional)

Geben Sie die Maschine oder Flotte an, auf der Ihr Workflow oder Ihre Workflow-Aktionen ausgeführt werden sollen. Bei bedarfsgesteuerten Flotten stellt der Workflow zu Beginn einer Aktion die benötigten Ressourcen bereit, und die Maschinen werden zerstört, wenn die Aktion abgeschlossen ist. Beispiele für Flotten auf Abruf:Linux.x86-64.Large,. Linux.x86-64.XLarge Weitere Informationen zu Flotten auf Abruf finden Sie unter. Flotteneigenschaften auf Abruf

Bei bereitgestellten Flotten konfigurieren Sie eine Reihe von dedizierten Maschinen, um Ihre Workflow-Aktionen auszuführen. Diese Maschinen bleiben inaktiv und können sofort Aktionen ausführen. Weitere Informationen zu bereitgestellten Flotten finden Sie unter. Bereitgestellte Flotteneigenschaften

Wenn Fleet es weggelassen wird, ist die Standardeinstellung. Linux.x86-64.Large

Weitere Informationen zu Rechenflotten finden Sie unterFlotten berechnen.

Entsprechende Benutzeroberfläche: Visual Editor/Workflow-Eigenschaften/Advanced/Compute Fleet

SharedInstance

(Compute/SharedInstance)

(Optional)

Geben Sie die Funktion zur gemeinsamen Nutzung von Rechenleistung für Ihre Aktionen an. Bei Compute Sharing werden Aktionen in einem Workflow auf derselben Instanz ausgeführt (Image der Laufzeitumgebung). Sie können einen der folgenden Werte verwenden:

Weitere Informationen zur gemeinsamen Nutzung von Compute finden Sie unterRechenleistung für mehrere Aktionen gemeinsam nutzen.

Entsprechende Benutzeroberfläche: keine

Triggers

(Optional)

Eine Sequenz von einem oder mehreren Triggern für diesen Workflow. Wenn kein Trigger angegeben ist, müssen Sie Ihren Workflow manuell starten.

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

Entsprechende Benutzeroberfläche: visueller Editor/Workflow-Diagramm/Trigger

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)

(Erforderlich, wenn gesetzt) Triggers

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

Beispiele finden Sie unter Beispiele: Trigger in Workflows.

Entsprechende Benutzeroberfläche: visueller Editor/Workflow-Diagramm/Trigger/Triggertyp

Events

(Triggers/Events)

(Erforderlich, wenn der Trigger auf gesetzt ist) Type PULLREQUEST

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

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

Beispiele finden Sie unter Beispiele: Trigger in Workflows.

Entsprechende Benutzeroberfläche: visueller Editor/Workflow-Diagramm/Trigger/Ereignisse für Pull-Requests

Branches

(Triggers/Branches)

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

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

Weitere Beispiele finden Sie unter Beispiele: Trigger in Workflows.

Entsprechende Benutzeroberfläche: visueller Editor/Workflow-Diagramm/Trigger/Zweige

FilesChanged

(Triggers/FilesChanged)

(Optional, wenn der Trigger auf, oder gesetzt ist. Type PUSH PULLREQUEST Wird nicht unterstützt, wenn der Trigger auf gesetzt Type istSCHEDULE.)

Geben Sie die Dateien oder Ordner in Ihrem Quell-Repository an, die der Trigger überwacht, um zu 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.

Entsprechende Benutzeroberfläche: visueller Editor/Workflow-Diagramm/Trigger/geänderte Dateien

Expression

(Triggers/Expression)

(Erforderlich, wenn der Trigger auf gesetzt ist) Type SCHEDULE

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

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

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.

Entsprechende Benutzeroberfläche: visueller Editor/Workflow-Diagramm/Trigger/Zeitplan

Aktionen

Eine Abfolge von einer oder mehreren Aktionen für diesen Workflow. CodeCatalyst unterstützt mehrere Aktionstypen, z. B. Build- und Testaktionen, die unterschiedliche Funktionen bieten. Jeder Aktionstyp hat:

Weitere Informationen zu den einzelnen Aktionstypen finden Sie unterAktionstypen. Das Aktionstypen Thema enthält Links zur Dokumentation der einzelnen Aktionen.

Im Folgenden finden Sie die YAML Referenz für Aktionen und Aktionsgruppen in der Workflow-Definitionsdatei.

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

action-or-gate-name

(Actions/action-or-gate-name)

(Erforderlich)

Ersetzen action-name mit einem Namen, den Sie der Aktion geben möchten. Aktionsnamen müssen innerhalb des Workflows eindeutig sein und dürfen nur alphanumerische Zeichen, Bindestriche und Unterstriche enthalten. Weitere Informationen zu Syntaxregeln finden Sie unter. YAMLRichtlinien für die Syntax

Weitere Informationen zu Benennungspraktiken für Aktionen, einschließlich Einschränkungen, finden Sie unteraction-or-gate-name.

Entsprechende Benutzeroberfläche: Visual Editor/action-name/Registerkarte „Konfiguration“/Aktionsname oder Anzeigename der Aktion

action-group-name

(Actions/action-group-name)

(Optional)

Eine Aktionsgruppe enthält eine oder mehrere Aktionen. Das Gruppieren von Aktionen in Aktionsgruppen hilft Ihnen dabei, Ihren Arbeitsablauf zu organisieren, und ermöglicht es Ihnen auch, Abhängigkeiten zwischen verschiedenen Gruppen zu konfigurieren.

Ersetzen action-group-name mit einem Namen, den Sie der Aktionsgruppe geben möchten. Namen von Aktionsgruppen müssen innerhalb des Workflows eindeutig sein und dürfen nur alphanumerische Zeichen, Bindestriche und Unterstriche enthalten. Weitere Informationen zu Syntaxregeln finden Sie unter. YAMLRichtlinien für die Syntax

Weitere Informationen zu Aktionsgruppen finden Sie unterGruppierung von Aktionen in Aktionsgruppen.

Entsprechende Benutzeroberfläche: keine