Zuul CI linter
Project description
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: "0.2.6"
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 array"
],
"sortJSON.orderOverride": ["title", "name", "$schema", "version", "description", "type"],
"sortJSON.orderUnderride": ["definitions"]
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
zuulcilint-0.2.6.tar.gz
(35.0 kB
view hashes)
Built Distribution
zuulcilint-0.2.6-py3-none-any.whl
(38.8 kB
view hashes)
Close
Hashes for zuulcilint-0.2.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf929d322234e2b45c8b056d7a052a5d8c2deebb051d9ee0b2cf95361cce4d90 |
|
MD5 | 20151eda750865719dc1ef46d0e6b363 |
|
BLAKE2b-256 | 13a0cd507a656696ea1b12cceeaa166510ba38add7d31d37ea7d2b8ec181264e |