README.md

zuul-lint

Validate from the command line

pip install zuul-lint

zuul-lint .zuul.yaml

Validate with pre-commit

Add the code below to your .pre-commit-config.yaml file:

  - repo: https://github.com/pycontribs/zuul-lint.git
    rev: "0.1"
    hooks:
      - id: zuul-lint

Validate with VS Code

To ease editing Zuul CI configuration file we added experimental support for a Zuul JSON Schema. This should enable validation and auto-completion in code editors.

For example on VSCode you can use the YAML extension to use such a schema validation by adding the following to settings.json:

"yaml.schemas": {
    "https://raw.githubusercontent.com/pycontribs/zuul-lint/master/zuul_lint/zuul-schema.json": ["*zuul.d/*.yaml", "*/.zuul.yaml"]
    },
"yaml.customTags": [
    "!encrypted/pkcs1-oaep array"
],
"sortJSON.orderOverride": ["title", "name", "$schema", "version", "description", "type"],
"sortJSON.orderUnderride": ["definitions"]