Development conventions

-----------------------

In order to maintain consistency across different roles and documentation, this

section describes development conventions that should be followed while making

modifications.

Task specifications

~~~~~~~~~~~~~~~~~~~

When writing new and updating existing tasks, keep the following in mind:

- Quote sensibly. If specifying paths (for example ``src``, ``dest``, ``path``

  etc in various models), quote the string to make it stand-out better and to

  avoid breakages.

- Avoid usage of ``set_facts`` task when same functionality can be achieved via

  ``defaults/main.yml``.

- When specifying tasks, use the fully expanded form. Do not use single-line

  form with ``param=value``.

- When specifying ``command`` or ``shell`` tasks, in case a ``creates``

  parameter or such need to be used, specify them as part of task's ``args``

  parameter. E.g.::

    - name: Run command

      command: mycommand

      args:

        creates: "/etc/mycommand"

- When sepcifying tasks, keep the following ordering between different task

  parameters:

  - ``name``

  - Module and its parameters.

  - ``become``

  - ``become_user``

  - ``when``

  - ``with_items`` / ``with_dict`` / ``with_nested``

  - ``wait_for``

  - ``register``

  - ``changed_when``

  - ``failed_when``

  - ``no_log``

  - ``notify``

  - Task tags.