mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 11:51:26 -07:00
eb1214baad
Changes to the metadata format were approved here: https://github.com/ansible/proposals/issues/54 * Update documentation to the new metadata format * Changes to metadata-tool to account for new metadata * Add GPL license header * Add upgrade subcommand to upgrade metadata version * Change default metadata to the new format * Fix exclusion of non-modules from the metadata report * Fix ansible-doc for new module metadata * Exclude metadata version from ansible-doc output * Fix website docs generation for the new metadata * Update metadata schema in valiate-modules test * Update the metadata in all modules to the new version
72 lines
2.2 KiB
Python
72 lines
2.2 KiB
Python
#!/usr/bin/python
|
|
# -*- mode: python -*-
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
|
'status': ['preview'],
|
|
'supported_by': 'core'}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
author:
|
|
- "Ansible Core Team (@ansible)"
|
|
module: include
|
|
short_description: include a play or task list.
|
|
description:
|
|
- Includes a file with a list of plays or tasks to be executed in the current playbook.
|
|
- Files with a list of plays can only be included at the top level, lists of tasks can only be included where tasks normally run (in play).
|
|
- Before 2.0 all includes were 'static', executed at play compile time.
|
|
- Static includes are not subject to most directives, for example, loops or conditionals, they are applied instead to each inherited task.
|
|
- Since 2.0 task includes are dynamic and behave more like real tasks. This means they can be looped, skipped and use variables from any source.
|
|
Ansible tries to auto detect this, use the `static` directive (new in 2.1) to bypass autodetection.
|
|
version_added: "0.6"
|
|
options:
|
|
free-form:
|
|
description:
|
|
- This module allows you to specify the name of the file directly w/o any other options.
|
|
notes:
|
|
- This is really not a module, though it appears as such, this is a feature of the Ansible Engine, as such it cannot be overridden the same way a module can.
|
|
'''
|
|
|
|
EXAMPLES = """
|
|
# include a play after another play
|
|
- hosts: localhost
|
|
tasks:
|
|
- debug:
|
|
msg: "play1"
|
|
|
|
- include: otherplays.yml
|
|
|
|
|
|
# include task list in play
|
|
- hosts: all
|
|
tasks:
|
|
- debug:
|
|
msg: task1
|
|
|
|
- include: stuff.yml
|
|
|
|
- debug:
|
|
msg: task10
|
|
|
|
# dyanmic include task list in play
|
|
- hosts: all
|
|
tasks:
|
|
- debug:
|
|
msg: task1
|
|
|
|
- include: "{{ hostvar }}.yml"
|
|
static: no
|
|
when: hostvar is defined
|
|
"""
|
|
|
|
RETURN = """
|
|
# this module does not return anything except plays or tasks to execute
|
|
"""
|