zuulcilint

Validate from the command line

pip install zuulcilint

usage: zuulcilint [-h] [--version] [--check-playbook-paths] [--schema SCHEMA] [--ignore-warnings] [--warnings-as-errors] file [file ...]

positional arguments:
  file                  file(s) or paths to lint

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --check-playbook-paths, -c
                        check that playbook paths are valid
  --schema SCHEMA, -s SCHEMA
                        path to Zuul schema file
  --ignore-warnings, -i
                        ignore warnings
  --warnings-as-errors  handle warnings as errors

Validate with pre-commit

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

  - repo: https://github.com/codesquadnest/zuulcilint.git
    rev: "1.0.0"
    hooks:
      - id: zuulcilint

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 .vscode/settings.json:

"yaml.schemas": {
  "https://raw.githubusercontent.com/codesquadnest/zuulcilint/master/zuulcilint/zuul-schema.json": [
      "*zuul-extra.d/***/*.yaml",
      "*zuul.d/**/*.yaml",
      "*zuul.d/**/**/*.yaml",
      "*/.zuul.yaml"
  ]
},
"yaml.customTags": [
  "!encrypted/pkcs1-oaep",
  "!encrypted/pkcs1-oaep sequence",
  "!override",
  "!override sequence",
  "!override mapping",
  "!inherit",
  "!inherit sequence",
  "!inherit mapping"
],
"sortJSON.orderOverride": ["title", "name", "$schema", "version", "description", "type"],
"sortJSON.orderUnderride": ["definitions"]