[](https://python-poetry.org/)
[](https://github.com/astral-sh/ruff)
[](https://opensource.org/licenses/MIT)
# 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.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](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/96/f0/e6fd9d20456a591e2c9256b366d65ba49a26aa5b3c7cea5e41d5ff19941d/zuulcilint-0.2.6.tar.gz",
"platform": null,
"description": "[](https://python-poetry.org/)\n[](https://github.com/astral-sh/ruff)\n[](https://opensource.org/licenses/MIT)\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.2.6\"\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.2.6",
"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": "13a0cd507a656696ea1b12cceeaa166510ba38add7d31d37ea7d2b8ec181264e",
"md5": "20151eda750865719dc1ef46d0e6b363",
"sha256": "bf929d322234e2b45c8b056d7a052a5d8c2deebb051d9ee0b2cf95361cce4d90"
},
"downloads": -1,
"filename": "zuulcilint-0.2.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "20151eda750865719dc1ef46d0e6b363",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 38805,
"upload_time": "2024-04-18T23:28:28",
"upload_time_iso_8601": "2024-04-18T23:28:28.784044Z",
"url": "https://files.pythonhosted.org/packages/13/a0/cd507a656696ea1b12cceeaa166510ba38add7d31d37ea7d2b8ec181264e/zuulcilint-0.2.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "96f0e6fd9d20456a591e2c9256b366d65ba49a26aa5b3c7cea5e41d5ff19941d",
"md5": "a0223fdd651ef5f399b09d1fbfdec973",
"sha256": "054f24131602127de9bebb475a9e06be4e359bb0314483ae281e77fd23898a0a"
},
"downloads": -1,
"filename": "zuulcilint-0.2.6.tar.gz",
"has_sig": false,
"md5_digest": "a0223fdd651ef5f399b09d1fbfdec973",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 34966,
"upload_time": "2024-04-18T23:28:29",
"upload_time_iso_8601": "2024-04-18T23:28:29.845306Z",
"url": "https://files.pythonhosted.org/packages/96/f0/e6fd9d20456a591e2c9256b366d65ba49a26aa5b3c7cea5e41d5ff19941d/zuulcilint-0.2.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 23:28:29",
"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
