ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Added recommendation about module name (#49540)

Browse source 
* Added recommendation about module name

Added general guidelines for naming a module.

Fixes: #19665

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
Abhijeet Kasurde 2018-12-05 21:00:40 +05:30 committed by Sandra McCann
parent 49009879b9
commit 287a42eba0
1 changed files with 22 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/docsite/rst/dev_guide/developing_modules_best_practices.rst
View file

@ -32,6 +32,7 @@ General guidelines & tips
========================= =========================
* Each module should be self-contained in one file, so it can be be auto-transferred by Ansible. * Each module should be self-contained in one file, so it can be be auto-transferred by Ansible.
* Module name MUST use underscores instead of hyphens or spaces as a word separator. Using hyphens and spaces will prevent Ansible from importing your module.
* Always use the ``hacking/test-module`` script when developing modules - it will warn you about common pitfalls. * Always use the ``hacking/test-module`` script when developing modules - it will warn you about common pitfalls.
* If you have a local module that returns facts specific to your installations, a good name for this module is ``site_facts``. * If you have a local module that returns facts specific to your installations, a good name for this module is ``site_facts``.
* Eliminate or minimize dependencies. If your module has dependencies, document them at the top of the module file and raise JSON error messages when dependency import fails. * Eliminate or minimize dependencies. If your module has dependencies, document them at the top of the module file and raise JSON error messages when dependency import fails.
@ -85,6 +86,7 @@ Importing and using shared code
HAS_LIB = False HAS_LIB = False
LIB_IMP_ERR = traceback.format_exc() LIB_IMP_ERR = traceback.format_exc()
Then in ``main()``, just after the argspec, do Then in ``main()``, just after the argspec, do
.. code-block:: python .. code-block:: python
@ -93,6 +95,7 @@ Importing and using shared code
module.fail_json(msg=missing_required_lib("foo"), module.fail_json(msg=missing_required_lib("foo"),
exception=LIB_IMP_ERR) exception=LIB_IMP_ERR)
And document the dependency in the ``requirements`` section of your module's :ref:`documentation_block`. And document the dependency in the ``requirements`` section of your module's :ref:`documentation_block`.
.. _module_failures: .. _module_failures: