View a markdown version of this page

Entwickeln, Testen und Bereitstellen mit Workflows - Amazon CodeCatalyst

Amazon CodeCatalyst ist nicht mehr offen für neue Kunden. Bestandskunden können den Service weiterhin wie gewohnt nutzen. Weitere Informationen finden Sie unter Wie migriert man von 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.

Entwickeln, Testen und Bereitstellen mit Workflows

Nachdem Sie Ihren Anwendungscode in einer CodeCatalyst Entwicklungsumgebung geschrieben und in Ihr CodeCatalyst Quell-Repository übertragen haben, können Sie ihn bereitstellen. Der Weg, dies automatisch zu tun, ist ein Workflow.

Ein Workflow ist ein automatisiertes Verfahren, das beschreibt, wie Sie Ihren Code als Teil eines Systems für kontinuierliche Integration und kontinuierliche Bereitstellung (CI/CD) erstellen, testen und bereitstellen. Ein Workflow definiert eine Reihe von Schritten oder Aktionen, die während einer Workflow-Ausführung durchzuführen sind. Ein Workflow definiert auch die Ereignisse oder Auslöser, die zum Starten des Workflows führen. Um einen Workflow einzurichten, erstellen Sie eine Workflow-Definitionsdatei mit dem visuellen Editor oder dem YAML-Editor der CodeCatalyst Konsole.

Tipp

Um einen kurzen Überblick darüber zu erhalten, wie Sie Workflows in einem Projekt verwenden können, erstellen Sie ein Projekt mit einem Blueprint. Jeder Blueprint stellt einen funktionierenden Workflow bereit, den Sie überprüfen, ausführen und mit dem Sie experimentieren können.

Über 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.

Das Folgende ist ein Beispiel für eine einfache Workflow-Definitionsdatei. Wir erklären jede Zeile dieses Beispiels in der folgenden Tabelle.

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 .
Linien Description
Name: MyWorkflow

Gibt den Namen des Workflows an. Weitere Hinweise zu der Name Eigenschaft finden Sie unterTop-level Eigenschaften.

SchemaVersion: 1.0

Gibt die Workflow-Schemaversion an. Weitere Hinweise zu der SchemaVersion Eigenschaft finden Sie unterTop-level Eigenschaften.

RunMode: QUEUED

Gibt an, wie mehrere Durchläufe CodeCatalyst behandelt werden. Weitere Hinweise zum Ausführungsmodus finden Sie unterKonfiguration des Warteschlangenverhaltens von Läufen.

Triggers:

Gibt die Logik an, die den Start einer Workflow-Ausführung veranlasst. Weitere Informationen zu Auslösern finden Sie unter Automatisches Starten einer Workflow-Ausführung mithilfe von Triggern.

- Type: PUSH Branches: - main

Gibt an, dass der Workflow immer dann gestartet werden muss, wenn Sie Code an den main Zweig des Standard-Quell-Repositorys übertragen. Weitere Informationen zur Workflow-Quelle finden Sie unterQuell-Repositorys mit Workflows verbinden.

Actions:

Definiert die Aufgaben, die während einer Workflow-Ausführung ausgeführt werden müssen. In diesem Beispiel definiert der Actions Abschnitt eine einzelne Aktion mit dem NamenBuild. Weitere Informationen zu Aktionen finden Sie unterWorkflow-Aktionen konfigurieren.

Build:

Definiert die Eigenschaften für die Build Aktion. Weitere Hinweise zur Build-Aktion finden Sie unterBauen mit Workflows.

Identifier: aws/build@v1

Gibt den eindeutigen, fest codierten Bezeichner für die Build-Aktion an.

Inputs: Sources: - WorkflowSource

Gibt an, dass die Build-Aktion im WorkflowSource Quell-Repository nach den Dateien suchen soll, die sie zum Abschluss der Verarbeitung benötigt. Weitere Informationen finden Sie unter Quell-Repositorys mit Workflows verbinden.

Configuration:

Enthält die Konfigurationseigenschaften, die für die Build-Aktion spezifisch sind.

Steps: - Run: docker build -t MyApp:latest .

Weist die Build-Aktion an, ein Docker-Image namens zu erstellen MyApp und es mit latest zu taggen.

Eine vollständige Liste aller in der Workflow-Definitionsdatei verfügbaren Eigenschaften finden Sie unterDefinition von Workflow-YAML.

Verwenden Sie die visuellen Editoren und die YAML-Editoren der CodeCatalyst Konsole

Zum Erstellen und Bearbeiten der Workflow-Definitionsdatei können Sie Ihren bevorzugten Editor verwenden. Wir empfehlen jedoch, den visuellen Editor oder den YAML-Editor der CodeCatalyst Konsole zu verwenden. Diese Editoren bieten eine hilfreiche Dateiüberprüfung, um sicherzustellen, dass YAML-Eigenschaftsnamen, Werte, Verschachtelung, Leerzeichen, Groß- und Kleinschreibung usw. korrekt sind.

Die folgende Abbildung zeigt einen Arbeitsablauf im visuellen Editor. Der visuelle Editor bietet Ihnen eine vollständige Benutzeroberfläche, über die Sie Ihre Workflow-Definitionsdatei erstellen und konfigurieren können. Der visuelle Editor umfasst ein Workflow-Diagramm (1), das die Hauptkomponenten des Workflows zeigt, und einen Konfigurationsbereich (2).

Visueller Workflow-Editor

Alternativ können Sie den YAML-Editor verwenden, der im nächsten Bild gezeigt wird. Verwenden Sie den YAML-Editor, um große Codeblöcke einzufügen (z. B. aus einem Tutorial) oder um erweiterte Eigenschaften hinzuzufügen, die im visuellen Editor nicht angeboten werden.

Arbeitsablauf: YAML-Editor

Sie können vom visuellen Editor zum YAML-Editor wechseln, um zu sehen, welche Auswirkungen Ihre Konfigurationen auf den zugrunde liegenden YAML-Code haben.

Workflows entdecken

Sie können Ihren Workflow zusammen mit anderen Workflows, die Sie im selben Projekt eingerichtet haben, auf der Workflow-Übersichtsseite anzeigen.

Das folgende Bild zeigt die Workflow-Übersichtsseite. Sie enthält zwei Workflows: BuildToProd und UnitTests. Sie können sehen, dass beide ein paar Mal ausgeführt wurden. Sie können Aktuelle Ausführungen wählen, um schnell den Ausführungsverlauf einzusehen, oder den Namen des Workflows wählen, um den YAML-Code des Workflows und andere detaillierte Informationen anzuzeigen.

Workflow-Protokolle

Details zur Workflow-Ausführung anzeigen

Sie können die Details einer Workflow-Ausführung anzeigen, indem Sie die Ausführung auf der Workflow-Übersichtsseite auswählen.

Die folgende Abbildung zeigt die Details einer Workflow-Ausführung mit dem Namen Run-cc11d, die bei einem Commit an die Quelle automatisch gestartet wurde. Das Workflow-Diagramm zeigt, dass eine Aktion fehlgeschlagen ist (1). Sie können zu den Protokollen (2) navigieren, um die detaillierten Protokollmeldungen anzuzeigen und Probleme zu beheben. Weitere Informationen zu Workflow-Ausführungen finden Sie unterEinen Workflow ausführen.

Workflow-Protokolle

Nächste Schritte

Weitere Informationen zu Workflow-Konzepten finden Sie unterWorkflow-Konzepte.

Informationen zum Erstellen Ihres ersten Workflows finden Sie unterErste Schritte mit Workflows.