Commit 0c100dd9 authored by nimrod's avatar nimrod
Browse files

Merge branch 'master' of cgit:/srv/git/ansible-role-example

parents a8af6e00 6d3347c0
Loading
Loading
Loading
Loading
+5 −35
Original line number Original line Diff line number Diff line
@@ -8,38 +8,8 @@ more information read the `blog post
Requirements
Requirements
------------
------------


See :code:`meta/main.yml`, :code:`requirements.yml` and assertions at top of
See :code:`meta/main.yml`, :code:`tests/requirements.yml` and assertions at
:code:`tasks/main.yml`.
the 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`.


Role Variables
Role Variables
--------------
--------------
@@ -59,8 +29,8 @@ See :code:`tests/playbook.yml`.
Testing
Testing
-------
-------


Testing requires Virtualbox and Vagrant (out of scope for this documentation).
Testing requires Virtualbox and Vagrant and Python 2.7. Install the Python
Install the Python dependencies, add pre-commit hooks by running:
dependencies, add pre-commit hooks by running:


.. code:: shell
.. code:: shell


@@ -72,8 +42,8 @@ To run the full test suite:
.. code:: shell
.. code:: shell


    ansible-galaxy install git+file://$(pwd),$(git rev-parse --abbrev-ref HEAD) -p .molecule/roles
    ansible-galaxy install git+file://$(pwd),$(git rev-parse --abbrev-ref HEAD) -p .molecule/roles
    pre-commit run --all-files
    molecule test --platform all
    molecule test --platform all
    pre-commit run --all-files


License
License
-------
-------