-
Notifications
You must be signed in to change notification settings - Fork 2
Home
Welcome to the official documentation for ZuulCIlint, an open-source project hosted on GitHub that aims to provide linting capabilities specifically tailored for Zuul configuration files. This tool is designed to catch potential issues and improve the overall quality of your Zuul CI configuration by checking aspects that Zuul doesn't automatically validate.
ZuulCIlint is a linting tool crafted to address the unique requirements of Zuul CI configuration files. While Zuul excels at managing CI/CD workflows, there are certain aspects that it may not check automatically. ZuulCIlint steps in to fill this gap by offering a specialized linting solution, ensuring your Zuul configurations meet the highest standards.
-
Zuul Configuration Validation: Detect and address issues in your Zuul CI configurations that might be missed during automated checks.
-
Integration with CI Pipelines: Seamlessly incorporate ZuulCIlint into your existing CI pipelines for streamlined code validation.
-
Open Source and Extensible: Contribute to the project's development and extend its capabilities to suit your requirements.
Whether you're a seasoned Zuul user or just getting started, this documentation will guide you through integrating ZuulCIlint into your project.
pip install zuulcilint
usage: zuulcilint [-h] [--version] [--check-playbook-paths] [--schema SCHEMA] 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
We encourage contributions from the community to enhance the functionality and coverage of ZuulCIlint.
Happy linting with ZuulCIlint!