Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

include_tasks until contradictory documentation #84822

Open
1 task done
Keeper-of-the-Keys opened this issue Mar 13, 2025 · 2 comments · May be fixed by #84847
Open
1 task done

include_tasks until contradictory documentation #84822

Keeper-of-the-Keys opened this issue Mar 13, 2025 · 2 comments · May be fixed by #84847
Labels
has_pr This issue has an associated PR. module This issue/PR relates to a module.

Comments

@Keeper-of-the-Keys
Copy link
Contributor

Summary

The attribute documentation of include_tasks lists until as "fully supported", the description there is "Denotes if this action obeys until/retry/poll keywords", however in the parameters section it says

The do-until loop is not supported.

How can both be true at the same time?

In practice include_tasks does not support until at this time and based on #83896 this is seen as a new feature

Issue Type

Documentation Report

Component Name

lib/ansible/modules/include_tasks.py

Ansible Version

"latest" on the docs website.

Configuration

not relevant

OS / Environment

not relevant

Additional Information

Right now the documentation seems to be self contradictory and I was only able to determine the "true" statement by trial and error, at first I thought maybe the do-until statement only applies when using the free-form but based on my observations and the issue mentioned before it is just not supported.

Code of Conduct

  • I agree to follow the Ansible Code of Conduct
@ansibot ansibot added needs_triage Needs a first human triage before being processed. module This issue/PR relates to a module. labels Mar 13, 2025
@ansibot
Copy link
Contributor

ansibot commented Mar 13, 2025

Files identified in the description:

If these files are incorrect, please update the component name section of the description or use the component bot command.

@sivel
Copy link
Member

sivel commented Mar 13, 2025

The documentation indicating full support is wrong. Just need to make the following change:

diff --git a/lib/ansible/plugins/doc_fragments/action_core.py b/lib/ansible/plugins/doc_fragments/action_core.py
index 9be51d7006..3cfc62dc69 100644
--- a/lib/ansible/plugins/doc_fragments/action_core.py
+++ b/lib/ansible/plugins/doc_fragments/action_core.py
@@ -76,4 +76,6 @@ attributes:
     tags:
       details: Tags are interpreted by this action but are not automatically inherited by the include tasks, see C(apply)
       support: partial
+    until:
+      support: none
 """

@bcoca bcoca linked a pull request Mar 17, 2025 that will close this issue
@ansibot ansibot added the has_pr This issue has an associated PR. label Mar 17, 2025
@bcoca bcoca removed the needs_triage Needs a first human triage before being processed. label Mar 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has_pr This issue has an associated PR. module This issue/PR relates to a module.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants