Das JSON-Schema „Workflows“ in Ihrer IDE verwenden

Zur Unterstützung der Syntax beim Erstellen eines Workflows können Sie die Methode Workflows-JSON-Schema in einer integrierten Entwicklungsumgebung (IDE) wie Visual Studio Code (VS Code) oder Intellij IDEA. Syntaxunterstützung umfasst automatische Vervollständigung, Validierung und Inline-Dokumentation. Das Schema kann in Ihre CI/CD-Prozesse integrieren.

Das JSON-Schema für Workflows ist in JSON Schema geschrieben, einer deklarativen Sprache, mit der Sie JSON-Dokumente annotieren und validieren können. Die Schemaquelle wird auf SchemaStore.org gehostet, Ein Repository mit Schemas für gängige JSON-basierte Konfigurationsdateien. Beachten Sie, dass Schemas von SchemaStore.org können auch auf YAML-Dateien angewendet werden.

Je nach der von Ihnen bevorzugten IDE oder dem Editor können Sie ein Plug-in installieren oder die integrierte Unterstützung für das Workflow-Schema verwenden. Das Schema können lokal im Projektstamm gespeichert oder über die Ressourcen-URL unter SchemaStore.org.

Dateinamenformat für Workflow-Definitionsdateien

Unabhängig von der verwendeten IDE oder dem Editor: Erweiterung zum automatischen Anwenden des Workflows-Schemas aus SchemaStore.org muss das Format des Dateinamens für Ihre Workflow-Definitionsdatei so aussehen:

  • workflows.json
  • workflows.yaml
  • workflows.yml
  • *.workflows.json
  • *.workflows.yaml
  • *.workflows.yml

Wenn Sie VS Code oder integrierte Unterstützung für die Anwendung des Workflows-Schema ist, können Sie die Dateinamensformate überschreiben.

Beschränkungen

Die Syntaxunterstützung durch das JSON-Schema für Workflows konzentriert sich auf die automatische Vervollständigung von keywords die einen Workflow definieren. Das Schema unterstützt die automatische Vervollständigung für einige Standardbibliotheksfunktionen, aber nur eingeschränkt für dynamische Variablennamen, Ausdrücke und andere Ausdruckshilfen. Das Schema geht auch davon aus, dass ein Workflow vollständig ist und berücksichtigt keine Nachverarbeitung wie das Kombinieren untergeordneter Workflows.

Um JSON-Schemakonflikte zu vermeiden, empfehlen wir, nicht mehr als eines zu verwenden Erweiterung oder Plug-in für die Syntaxunterstützung von Workflows.

JSON-Schema für Workflows in VS Code verknüpfen

VS Code ist ein Quellcode-Editor, der auf Ihrem Desktop ausgeführt wird und für Windows, macOS und Linux Es unterstützt mehrere Sprachen. und unterstützt Erweiterungen für andere Sprachen und Laufzeiten. Informationen zum Installieren und Einrichten von VS Code auf Ihrem Computer finden Sie unter Visual Studio Code.

Im Folgenden finden Sie verschiedene Möglichkeiten, wie Sie das JSON-Schema für Workflows in VS Code verknüpfen können.

Mit Cloud Code Workflows in YAML erstellen

Cloud Code besteht aus einer Reihe von IDE-Plug-ins, mit denen sich Anwendungen einfacher erstellen, bereitstellen und in Google Cloud einbinden lassen.

Wenn Sie VS Code als IDE verwenden, können Sie Cloud Code in folgenden Fällen verwenden: wenn Sie Ihre YAML-Workflows Workflows-JSON-Schema von SchemaStore.org. Zur Bestätigung, dass wie erwartet angewendet wird, erstellen Sie einen YAML-Workflow in einem Arbeitsbereich oder Ordner und bestätigen Sie, dass die automatische Vervollständigung für Workflows-Keywords.

Cloud Code unterstützt auch Google Cloud-Offlineschemas und kann die möglicherweise von Netzwerk- oder IDE-Einschränkungen verwendet werden. Weitere Informationen sollten Sie Folgendes beachten:

YAML von RedHat zum Erstellen von Workflows in YAML verwenden

Als Alternative zur Verwendung der Cloud Code for VS Code-Erweiterung können Sie die Erweiterung „YAML by RedHat“ Diese Erweiterung bietet Unterstützung für die YAML-Sprache und enthält eine integrierte Unterstützung für die Kubernetes-Syntax. Das JSON-Format für Workflows wird automatisch abgerufen. von SchemaStore.org.

Erstellen Sie nach der Installation der Erweiterung einen YAML-Workflow. Oben auf der sollte ein Link zur Google Cloud Workflows-Konfigurationsdatei (workflows.json). Wenn Sie auf den Link klicken, wird das JSON-Schema für Workflows im VS Code-Editor geöffnet.

Dateinamensformate überschreiben

Wenn Sie entweder Cloud Code oder YAML von RedHat zum Erstellen von Workflows in YAML verwenden, können Sie die Standardformate für Dateinamen überschreiben, Schema angewendet wird. Sie müssen eine Zuordnung in der settings.json-Datei angeben. Die Einstellungen sind als JSON geschrieben. Sie können diese Datei direkt überprüfen und bearbeiten, indem Sie sie im VS Code-Editor öffnen.

Wenn Sie beispielsweise die Cloud Code for VS Code-Erweiterung verwenden, können Sie unter der Eigenschaft cloudcode.yaml.schemas ein Dateiformat zuordnen:

{
    "cloudcode.yaml.schemas": {
        "https://json.schemastore.org/workflows.json": [
            "GLOB_PATTERN.yaml",
            "my-special-workflow.yaml"
        ]
    }
}

Wenn Sie die Erweiterung YAML by RedHat verwenden, ordnen Sie das Dateinamensformat unter Attribut yaml.schemas:

{
    "yaml.schemas": {
        "https://json.schemastore.org/workflows.json": [
            "GLOB_PATTERN.yaml",
            "my-special-workflow.yaml"
        ]
    }
}

Die Schemas auf der linken Seite werden auf die Glob-Muster auf der rechten Seite angewendet. Jedes Schema ist über ein JSON-Array mit mehreren Globs verknüpft. Ihr Schema muss relativen Pfads und keinen absoluten Pfad. Das Schema kann lokal oder online sein.

Integrierte Unterstützung zum Erstellen von Workflows in JSON nutzen

Sie können die integrierte Unterstützung in VS Code nutzen, um die Workflows JSON-Schema durch Angabe der Zuordnung in der Datei settings.json unter dem Property json.schemas. Sie können diese Datei direkt prüfen und bearbeiten, indem Sie Öffnen Sie sie im VS Code-Editor.

Um das JSON-Schema "Workflows" beispielsweise aus SchemaStore.org:

{
    "json.schemas": [
        {
            "description": "SchemaStore.org",
            "fileMatch": [
                "workflows.json",
                "*.workflows.json"
            ],
            "url": "https://json.schemastore.org/workflows.json"
         }
    ]
}

Die Schemas auf der linken Seite werden auf die glob-Muster auf der rechten Seite angewendet. ein Schema mit mehreren Globs über ein JSON-Array verknüpft. Das Schema muss ein relativen Pfads und keinen absoluten Pfad. Das Schema kann lokal oder online sein.

Sie können das Format des Dateinamens überschreiben. Beispiel:

{
    "json.schemas": [
        {
            "description": "Workflows schema",
            "fileMatch": [
                "GLOB_PATTERN.json",
                "FILE_NAME.json"
            ],
            "url": "https://json.schemastore.org/workflows.json"
        }
    ]
}

Weitere Informationen finden Sie unter JSON mit Visual Studio Code bearbeiten

JSON-Schema „Workflows“ in IntelliJ IDEA verknüpfen

IntelliJ IDEA ist eine plattformübergreifende IDE für Java Virtual Machine-Sprachen. Sonstiges Sprachen werden über Plug-ins unterstützt. Informationen zum Installieren und Einrichten von IntelliJ IDEA auf Ihrem Computer finden Sie unter IntelliJ IDEA installieren.

Im Folgenden finden Sie verschiedene Möglichkeiten, wie Sie die Workflows verknüpfen können. JSON-Schema in IntelliJ IDEA.

Mit Cloud Code Workflows in YAML oder JSON erstellen

Cloud Code besteht aus einer Reihe von IDE-Plug-ins, mit denen sich Anwendungen einfacher erstellen, bereitstellen und in Google Cloud einbinden lassen.

Wenn Sie IntelliJ als IDE verwenden, können Sie Cloud Code verwenden, um Ihre Workflows in YAML oder JSON zu erstellen. Das JSON-Schema für Workflows wird dann automatisch von SchemaStore.org abgerufen. Cloud Code unterstützt auch Google Cloud-Offlineschemas und können von Nutzern verwendet werden, Netzwerk- oder IDE-Einschränkungen haben. Weitere Informationen finden Sie unter:

Integrierte Unterstützung für das Erstellen von Workflows in YAML oder JSON

IntelliJ IDEA kann Schemas automatisch von SchemaStore.org herunterladen und verwenden. Sie können das JSON-Schema für Workflows herunterladen und unter folgendem Pfad speichern: Projektstammverzeichnis oder geben Sie die URL der Ressource an, damit IntelliJ IDEA laden Sie das Schema automatisch herunter. Um das Schema zuzuordnen, folgen Sie der Anleitung unter Ein benutzerdefiniertes JSON-Schema konfigurieren

Standardmäßig automatischen Download von Schemas von SchemaStore.org aktiviert sind und die standardmäßigen Dateinamenmuster anhand des Schemas validiert werden.

Um die Standard-Dateimuster zu überschreiben, JSON-Schemazuordnungen über das Dialogfeld Einstellungen:

  1. Geben Sie in das Feld Name Workflows schema ein.
  2. Geben Sie im Feld Schema oder URL https://json.schemastore.org/workflows.json.
  3. Wählen Sie in der Liste Schemaversion die Option JSON-Schemaversion 7 aus.
  4. Fügen Sie ein Dateipfadmuster Ihrer Wahl hinzu.

Schema über jsonSchema.xml zuordnen

Der Quellcode der IntelliJ IDEA Community Edition ist verfügbar über https://github.com/JetBrains/intellij-community.

Sie können das JSON-Schema „Workflows“ für IntelliJ IDEA zuordnen indem Sie einen Eintrag zu jsonSchemas.xml.

CI/CD-Prozessen eine Syntaxprüfung für Workflows hinzufügen

Wenn Sie Ihren CI/CD-Prozessen (Continuous Integration/Continuous Deployment) eine Syntaxprüfung hinzufügen, können Sie Fehler bei der Integration, beim Testen, bei der Bereitstellung und beim Deployment reduzieren.

Beispielsweise können Sie Daten anhand der Workflows-JSON-Datei validieren. Schema mithilfe von ajv-cli . Beachten Sie, dass Sie beim Installieren des Tools ajv-formats. Beispiel:

npm install -g ajv-cli ajv-formats

Weitere nützliche Tools:

  • MegaLinter v8r: MegaLinter ist ein Open-Source-Tool für CI/CD-Workflows. v8r prüft die Gültigkeit von JSON/YAML -Dateien, wenn für diese ein übereinstimmendes Schema auf SchemaStore.org definiert ist.
  • JSON-Validatoren: JSON Validierungstools nach Programmiersprache oder Entwicklungsplattform kategorisiert.

Nächste Schritte