Ansible pre-commit hooks
Ansible pre-commit hooks.
- ansible-syntax-check: The hook runs
ansible --syntax-check
against playbooks declared. - ansible-vault-check: The hook verifies that files that have
vault
in the filename are indeed vaulted.
Requirements
- Pre-commit 1.2 or later.
- Python 2.7 or 3.4 or later.
Installation
Add the following to your .pre-commit-config.yaml
:
- repo: https://www.shore.co.il/git/ansible-pre-commit/
sha: v0.9.0
hooks:
- id: ansible-syntax-check
files: site.yml #In case you want to specify other playbook files.
- id: ansible-vault-check
And in the next pre-commit
will install and run the hooks. In case
your roles
directory isn't in the same directory as the playbook
you're testing or at /etc/ansible/roles
you need to declare the roles
search path in ansible.cfg
in the root of the repo like so:
[defaults]
roles_path=path/to/roles/directory:path/to/another/roles/directory
License
This software is licensed under the MIT license (see the LICENSE.txt
file).
Author Information
Nimrod Adar, contact me or visit my website. Patches are welcome via git send-email. The repository is located at: https://www.shore.co.il/git/.