From a7c915090cd2b8565b517c6bd4181421006a8203 Mon Sep 17 00:00:00 2001 From: Adar Nimrod <nimrod@shore.co.il> Date: Tue, 24 Jan 2017 17:03:57 +0200 Subject: [PATCH] - Updated documentation. - Raised requirements to Python 3.4 or newer. - Read version in setup.py from the VERSION file. --- .travis.yml | 2 +- README.rst | 17 ++++++++--------- setup.py | 2 +- 3 files changed, 10 insertions(+), 11 deletions(-) diff --git a/.travis.yml b/.travis.yml index 3a0949e..4f7116e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,6 @@ --- 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 diff --git a/README.rst b/README.rst index 441f532..8cedd20 100644 --- a/README.rst +++ b/README.rst @@ -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:: diff --git a/setup.py b/setup.py index e6255b6..20c081f 100644 --- a/setup.py +++ b/setup.py @@ -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'], ) -- GitLab