| commit | 792be4f498849e1f294f6bac7ff7e8bb0618efba | [log] [tgz] |
|---|---|---|
| author | Thomas Draebing <thomas.draebing@sap.com> | Thu Sep 19 11:57:56 2019 +0200 |
| committer | David Pursehouse <dpursehouse@collab.net> | Tue Oct 08 00:37:13 2019 +0000 |
| tree | 0263281ffb6a8c4234ef2a884bb87f3c1b87b4e6 | |
| parent | c1b1fd623b5c242a7fc56e9140e17ef382c7fb1b [diff] |
Lint JJB-yaml files The yaml-files used to describe the jobs, were not consistently using whitespaces and single-quotes. This change lints the yaml files using yamllint, a python-based tool to lint yaml files. This change also provides a description of how to use yamllint and a configuration. Change-Id: I36f8c4982a72cd567fc1035b876db245d80d2a32
This project uses Jenkins Jobs Builder [1] to generate jobs from yaml descriptor files.
To add new jobs reuse existing templates, defaults etc. as much as possible. E.g. adding a job to build an additional branch of a project may be as easy as adding the name of the branch to an existing project.
To ensure well readable yaml-files, use yamllint [2] to lint the yaml-files. Yamllint can be downloaded using Python Pip:
pip3 install yamllint
To run the linter, execute this command from the project's root directory:
yamllint -c yamllint-config.yaml jenkins/**/*.yaml
Yamllint will not fix detected issues itself.
[1] https://docs.openstack.org/infra/jenkins-job-builder/index.html [2] https://pypi.org/project/yamllint/