[](https://python-poetry.org/)
[](https://github.com/astral-sh/ruff)
[](https://opensource.org/licenses/MIT)
[](https://snyk.io/advisor/python/zuulcilint)
# 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:
```yaml
- repo: https://github.com/codesquadnest/zuulcilint.git
rev: "0.3.1"
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](https://code.visualstudio.com) you can use the [YAML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) extension to use such a schema
validation by adding the following to `.vscode/settings.json`:
```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"]
```
Raw data
{
"_id": null,
"home_page": "https://github.com/codesquadnest/zuulcilint",
"name": "zuulcilint",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "zuul, ci, linter",
"author": "Pedro Baptista",
"author_email": "pedro.miguel.baptista@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/48/9f/b9790a6f24870e1e83b596cff2ff3bbeb1c2dc953d031ec1f94247448fef/zuulcilint-0.3.1.tar.gz",
"platform": null,
"description": "[](https://python-poetry.org/)\n[](https://github.com/astral-sh/ruff)\n[](https://opensource.org/licenses/MIT)\n[](https://snyk.io/advisor/python/zuulcilint)\n\n# zuulcilint\n\n## Validate from the command line\n\n```\npip install zuulcilint\n\nusage: zuulcilint [-h] [--version] [--check-playbook-paths] [--schema SCHEMA] [--ignore-warnings] [--warnings-as-errors] file [file ...]\n\npositional arguments:\n file file(s) or paths to lint\n\noptions:\n -h, --help show this help message and exit\n --version show program's version number and exit\n --check-playbook-paths, -c\n check that playbook paths are valid\n --schema SCHEMA, -s SCHEMA\n path to Zuul schema file\n --ignore-warnings, -i\n ignore warnings\n --warnings-as-errors handle warnings as errors\n```\n\n## Validate with pre-commit\n\nAdd the code below to your `.pre-commit-config.yaml` file:\n\n```yaml\n - repo: https://github.com/codesquadnest/zuulcilint.git\n rev: \"0.3.1\"\n hooks:\n - id: zuulcilint\n```\n\n\n## Validate with VS Code\n\nTo ease editing Zuul CI configuration file we added experimental support for\na Zuul JSON Schema. This should enable validation and auto-completion in\ncode editors.\n\nFor example on [VSCode](https://code.visualstudio.com) you can use the [YAML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) extension to use such a schema\nvalidation by adding the following to `.vscode/settings.json`:\n\n\n```json\n\"yaml.schemas\": {\n \"https://raw.githubusercontent.com/codesquadnest/zuulcilint/master/zuulcilint/zuul-schema.json\": [\n \"*zuul-extra.d/***/*.yaml\",\n \"*zuul.d/**/*.yaml\",\n \"*zuul.d/**/**/*.yaml\",\n \"*/.zuul.yaml\"\n ]\n},\n\"yaml.customTags\": [\n \"!encrypted/pkcs1-oaep array\"\n],\n\"sortJSON.orderOverride\": [\"title\", \"name\", \"$schema\", \"version\", \"description\", \"type\"],\n\"sortJSON.orderUnderride\": [\"definitions\"]\n\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Zuul CI linter",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/codesquadnest/zuulcilint",
"Repository": "https://github.com/codesquadnest/zuulcilint"
},
"split_keywords": [
"zuul",
" ci",
" linter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "241785e10daf71f32bd1925439a910d7a1ceb2e12436d6a3ff1cfe1a5c1c82c4",
"md5": "da28678d025d682402b4496b6db8702f",
"sha256": "0e5b60ded7236350e3d4cb992875375035543c45eacfb5e248ec232b3485f968"
},
"downloads": -1,
"filename": "zuulcilint-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "da28678d025d682402b4496b6db8702f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 39833,
"upload_time": "2024-11-20T16:38:08",
"upload_time_iso_8601": "2024-11-20T16:38:08.666969Z",
"url": "https://files.pythonhosted.org/packages/24/17/85e10daf71f32bd1925439a910d7a1ceb2e12436d6a3ff1cfe1a5c1c82c4/zuulcilint-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "489fb9790a6f24870e1e83b596cff2ff3bbeb1c2dc953d031ec1f94247448fef",
"md5": "15049d4d32bcd042bf28e0ce77954169",
"sha256": "847e5c589fbc095bfffc77103280476c32c0fcdf9a9660264edba0ee91ce6977"
},
"downloads": -1,
"filename": "zuulcilint-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "15049d4d32bcd042bf28e0ce77954169",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 36006,
"upload_time": "2024-11-20T16:38:10",
"upload_time_iso_8601": "2024-11-20T16:38:10.262540Z",
"url": "https://files.pythonhosted.org/packages/48/9f/b9790a6f24870e1e83b596cff2ff3bbeb1c2dc953d031ec1f94247448fef/zuulcilint-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 16:38:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "codesquadnest",
"github_project": "zuulcilint",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "zuulcilint"
}
JSON
