default_callback: Move 'check_mode_markers' in doc_fragments (#70228)
Callback plugin dense, yaml, and debug implement 'check_mode_markers' so moving documentation to default callback doc_fragments. Fixes: https://github.com/ansible-collections/community.general/issues/565 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
parent
70c59423fc
commit
4885ebad27
3 changed files with 16 additions and 18 deletions
2
changelogs/fragments/565_default_callback.yml
Normal file
2
changelogs/fragments/565_default_callback.yml
Normal file
|
@ -0,0 +1,2 @@
|
|||
minor_changes:
|
||||
- default_callback - moving 'check_mode_markers' documentation in default_callback doc_fragment (https://github.com/ansible-collections/community.general/issues/565).
|
|
@ -16,26 +16,8 @@ DOCUMENTATION = '''
|
|||
- default_callback
|
||||
requirements:
|
||||
- set as stdout in configuration
|
||||
options:
|
||||
check_mode_markers:
|
||||
name: Show markers when running in check mode
|
||||
description:
|
||||
- "Toggle to control displaying markers when running in check mode. The markers are C(DRY RUN)
|
||||
at the beggining and ending of playbook execution (when calling C(ansible-playbook --check))
|
||||
and C(CHECK MODE) as a suffix at every play and task that is run in check mode."
|
||||
type: bool
|
||||
default: no
|
||||
version_added: 2.9
|
||||
env:
|
||||
- name: ANSIBLE_CHECK_MODE_MARKERS
|
||||
ini:
|
||||
- key: check_mode_markers
|
||||
section: defaults
|
||||
'''
|
||||
|
||||
# NOTE: check_mode_markers functionality is also implemented in the following derived plugins:
|
||||
# debug.py, yaml.py, dense.py. Maybe their documentation needs updating, too.
|
||||
|
||||
|
||||
from ansible import constants as C
|
||||
from ansible import context
|
||||
|
|
|
@ -68,4 +68,18 @@ class ModuleDocFragment(object):
|
|||
- key: show_per_host_start
|
||||
section: defaults
|
||||
version_added: '2.9'
|
||||
check_mode_markers:
|
||||
name: Show markers when running in check mode
|
||||
description:
|
||||
- Toggle to control displaying markers when running in check mode.
|
||||
- "The markers are C(DRY RUN) at the beggining and ending of playbook execution (when calling C(ansible-playbook --check))
|
||||
and C(CHECK MODE) as a suffix at every play and task that is run in check mode."
|
||||
type: bool
|
||||
default: no
|
||||
version_added: '2.9'
|
||||
env:
|
||||
- name: ANSIBLE_CHECK_MODE_MARKERS
|
||||
ini:
|
||||
- key: check_mode_markers
|
||||
section: defaults
|
||||
'''
|
||||
|
|
Loading…
Reference in a new issue