diff options
| author | Brian Coca <bcoca@users.noreply.github.com> | 2022-04-27 09:46:52 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-27 09:46:52 -0400 |
| commit | b439e41a915ccec0ccbabecc966919ea406db74e (patch) | |
| tree | bf8f135022a43bd8e61b8a2206531a76404e62c3 /lib/ansible/plugins/test/skipped.yml | |
| parent | a65fbfad5b20b23b41c4f8cdd82161bb8c365953 (diff) | |
| download | ansible-b439e41a915ccec0ccbabecc966919ea406db74e.tar.gz | |
expand ansible-doc coverage (#74963)
* Expand ansible-doc to tests/filters and fix existing issues
enable filter/test docs if in single file or companion yaml
add docs for several filters/tests plugins
allow .yml companion for docs for other plugins, must be colocated
verify plugins are valid (not modules, cannot)
fix 'per collection' filtering
limit old style deprecation (_ prefix) to builtin/legacy
start move to pathlib for saner path handling
moved some funcitons, kept backwards compat shims with deprecation notice
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Diffstat (limited to 'lib/ansible/plugins/test/skipped.yml')
| -rw-r--r-- | lib/ansible/plugins/test/skipped.yml | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/lib/ansible/plugins/test/skipped.yml b/lib/ansible/plugins/test/skipped.yml new file mode 100644 index 0000000000..692c536e87 --- /dev/null +++ b/lib/ansible/plugins/test/skipped.yml @@ -0,0 +1,21 @@ +DOCUMENTATION: + name: skipped + author: Ansible Core + version_added: "1.9" + short_description: check if task was skipped + description: + - Tests if task was skipped + - This test checks for the existance of a C(skipped) key in the input dictionary and that it is C(True) if present + options: + _input: + description: registered result from an Ansible task + type: dictionary + required: True +EXAMPLES: | + # test 'status' to know how to respond + {{ (taskresults is skipped}} + +RETURN: + _value: + description: Returns C(True) if the task was skipped, C(False) otherwise. + type: boolean |