starred/ansible
1
0
Fork 0
mirror of https://github.com/ansible/ansible.git synced 2026-08-03 08:03:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: dash - character invalid in playbook names in collections(#75891)

Browse Source 
* collection playbooks, note no -
fixes #75890
This commit is contained in:
Brian Coca
2021-10-14 08:25:14 -07:00
committed by GitHub
parent 9eeaf1c5b5
commit ff792d252e
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docsite/rst/user_guide/collections_using.rst
+5
View File
@@ -371,6 +371,11 @@ A few recommendations when creating such playbooks, ``hosts:`` should be generic
This will have an implied entry in the ``collections:`` keyword of ``my_namespace.my_collection`` just as with roles.
.. note::
Playbook names, like other collection resources, have a restricted set of valid characters.
Names can contain only lowercase alphanumeric characters, plus _ and must start with an alpha character. The dash ``-`` character is not valid for playbook names in collections.
Playbooks whose names contain invalid characters are not addressable: this is a limitation of the Python importer that is used to load collection resources.
.. seealso::
:ref:`developing_collections`