Commit a7c91509 authored by nimrod's avatar nimrod
Browse files

- Updated documentation.

- Raised requirements to Python 3.4 or newer.
- Read version in setup.py from the VERSION file.
parent 3c3ee987
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
---
language: python
python: ["2.7", "3.3", "3.4", "3.5", "3.6"]
python: ["2.7", "3.4", "3.5", "3.6"]
dist: trusty
sudo: false
group: beta
+8 −9
Original line number Diff line number Diff line
@@ -11,11 +11,11 @@ Ansible `pre-commit <http://pre-commit.com/>`_ hooks.
- ansible-vault-check: The hook verifies that files that have :code:`vault` in
  the filename are indeed vaulted.

Dependencies
Requirements
------------

- Ansible.
- Pre-commit.
- Python 2.7 or 3.4 or later.

Installation
------------
@@ -25,17 +25,16 @@ Add the following to your :code:`.pre-commit-config.yaml`:
.. code:: yaml

    - repo: https://www.shore.co.il/git/ansible-pre-commit/
      sha: v0.4.0
      sha: v0.5.0
      hooks:
      - id: ansible-syntax-check
        # In case you want to specify other playbook files:
        files: playbook.yml
        files: site.yml #In case you want to specify other playbook files.
      - id: ansible-vault-check

And run :code:`pre-commit autoupdate` to update the hooks. In case your
:code:`roles` directory isn't in the same directory as the playbook you're
testing or at :code:`/etc/ansible/roles` you need to declare the roles search
path in :code:`ansible.cfg` in the root of the repo like so:
And in the next :code:`pre-commit` will install and run the hooks. In case
your :code:`roles` directory isn't in the same directory as the playbook
you're testing or at :code:`/etc/ansible/roles` you need to declare the roles
search path in :code:`ansible.cfg` in the root of the repo like so:

.. code::

+1 −1
Original line number Diff line number Diff line
@@ -6,6 +6,6 @@ setup(
        url='https://www.shore.co.il/git/ansible-pre-commit',
        author='Nimrod Adar',
        author_email='nimrod@shore.co.il',
        version='0.1.0',
        version=open('VERSION', 'r').read(),
        install_requires=['ansible==2.2.1.0'],
)