diff --git a/README.rst b/README.rst index cdbd5449aadbde144cb9afea3900fd9cdd1483ed..29b4ed2fa7911e1bf9ec9e904ee61f1b63a85b6b 100644 --- a/README.rst +++ b/README.rst @@ -8,38 +8,8 @@ more information read the `blog post Requirements ------------ -See :code:`meta/main.yml`, :code:`requirements.yml` and assertions at top of -:code:`tasks/main.yml`. - -Adding the role as a dependency -------------------------------- - -Add the following to your :code:`meta/main.yml`: - -.. code:: yaml - - dependencies: - - src: https://www.shore.co.il/git/ansible-role-example - scm: git - name: example - -When :code: `ansible-galaxy` downloads your role it will also download its -dependencies, ensuring this role will be present and run everytime your role -runs. - -Adding the role to your playbooks ---------------------------------- - -Add the following to your :code:`requirements.yml`: - -.. code:: yaml - - - src: https://www.shore.co.il/git/ansible-role-example - scm: git - name: example - -and update your roles by running :code: `ansible-galaxy install -r -requirements.yml`. +See :code:`meta/main.yml`, :code:`tests/requirements.yml` and assertions at +the top of :code:`tasks/main.yml`. Role Variables -------------- @@ -59,8 +29,8 @@ See :code:`tests/playbook.yml`. Testing ------- -Testing requires Virtualbox and Vagrant (out of scope for this documentation). -Install the Python dependencies, add pre-commit hooks by running: +Testing requires Virtualbox and Vagrant and Python 2.7. Install the Python +dependencies, add pre-commit hooks by running: .. code:: shell @@ -72,8 +42,8 @@ To run the full test suite: .. code:: shell ansible-galaxy install git+file://$(pwd),$(git rev-parse --abbrev-ref HEAD) -p .molecule/roles - pre-commit run --all-files molecule test --platform all + pre-commit run --all-files License -------