README.md

concourse-jsonschema-generator

Transforms the booklit documentation of Concourse into a detailed JSONSchema with docs

usage

You can regenerate the schema by passing it the contents of the concourse docs repo and globbing the .lit files

cargo build --release
./target/release/concourse-jsonschema-generator \
  path/to/concourse/docs/lit/docs/**/*.lit | jq > schema.json

You can also use the pre-generated shema from this repo directly.

First, install the vscode yaml extension (or the redhat yaml LSP server) for your editor.

Then add the schema with a directive at the top of the pipeline file

# yaml-language-server: $schema=https://raw.githubusercontent.com/spion/concourse-jsonschema-generator/main/schema.json

resource_types:
  # ...
resources:
  # ...
jobs:
  # ...