diff --git a/README.rst b/README.rst index 3eccb30fd09de7878a622f2ffa630dc8c8b03ab9..35cef5185eff898d45fc192de7261918ecef6f15 100644 --- a/README.rst +++ b/README.rst @@ -1,21 +1,10 @@ -Ansible pre-commit hooks -######################## +Documentation pre-commit hooks +############################## -.. image:: https://travis-ci.org/adarnimrod/ansible-pre-commit.svg?branch=master - :target: https://travis-ci.org/adarnimrod/ansible-pre-commit +.. image:: https://travis-ci.org/adarnimrod/docs-pre-commit.svg?branch=master + :target: https://travis-ci.org/adarnimrod/docs-pre-commit -Ansible `pre-commit <http://pre-commit.com/>`_ hooks. - -- ansible-syntax-check: The hook runs - :code:`ansible --syntax-check` against playbooks declared. -- ansible-vault-check: The hook verifies that files that have :code:`vault` in - the filename are indeed vaulted. - -Dependencies ------------- - -- Ansible. -- Pre-commit. +Documentation `pre-commit <http://pre-commit.com/>`_ hooks. Installation ------------ @@ -24,23 +13,7 @@ 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 - hooks: - - id: ansible-syntax-check - # In case you want to specify other playbook files: - files: playbook.yml - - 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: - -.. code: - - [defaults] - roles_path=path/to/roles/directory:path/to/another/roles/directory + - repo: https://git.shore.co.il/nimrod/docs-pre-commit.git License ------- @@ -54,4 +27,4 @@ Author Information Nimrod Adar, `contact me <nimrod@shore.co.il>`_ or visit my `website <https://www.shore.co.il/>`_. Patches are welcome via `git send-email <http://git-scm.com/book/en/v2/Git-Commands-Email>`_. The repository is located -at: https://www.shore.co.il/git/. +at: https://git.shore.co.il/nimrod/. diff --git a/ansible-syntax-check b/ansible-syntax-check deleted file mode 100755 index e933723bdca7e94662e9cb17bc4b200434a20e64..0000000000000000000000000000000000000000 --- a/ansible-syntax-check +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/sh -set -eu -for playbook in $@ -do - ansible-playbook --inventory=localhost, --syntax-check "$playbook" -done diff --git a/ansible-vault-check b/ansible-vault-check deleted file mode 100755 index 41aa16cba0d3f7cc5ff7ed90995925e88c9a1faf..0000000000000000000000000000000000000000 --- a/ansible-vault-check +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/sh -set -eu -for filename in $@ -do - grep -q ANSIBLE_VAULT "$filename" || \ - (echo "$filename is not vaulted." && exit 1) -done diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index d700ebe1a64351d8b787f13528c28c44413500d2..0000000000000000000000000000000000000000 --- a/requirements.txt +++ /dev/null @@ -1,3 +0,0 @@ -ansible==2.2.1.0 -pre-commit==0.11.0 -piprot==0.9.7