Skip to content

IDE Set-Up

Validating Argo YAML against the JSON Schema

Argo provides a JSON Schema that enables validation of YAML resources in your IDE.

IntelliJ IDEA (Community & Utimate Editions)

YAML validation is supported natively in IDEA.

Configure your IDE to reference the Argo schema and map it to your Argo YAML files:

IDEA Configure Schema - The schema is located at https://raw.githubusercontent.com/argoproj/argo-workflows/master/api/jsonschema/schema.json. - Specify a file glob pattern that locates your Argo files. The example glob here is for the Argo Github project! - Note that you may need to restart IDEA to pick up the changes.

That's it. Open an Argo YAML file and you should see smarter behaviour, including type errors and context-sensitive autocomplete.

IDEA Example Functionality

VSCode

The Red Hat YAML plugin will provide error highlighting and autocompletion for Argo resources.

Install the Red Hat YAML plugin in VSCode and open extension settings:

VSCode Install Plugin

Open the YAML schemas settings:

VSCode YAML Schema Settings

Add the Argo schema setting yaml.schemas:

VSCode Specify Argo Schema

That's it. Open an Argo YAML file and you should see smarter behaviour, including type errors and context-sensitive autocomplete.

VScode Example Functionality