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

Add a note for --start-at-task #1706

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from

Conversation

Akasurde
Copy link
Member

SUMMARY

add a note stating what --start-at-task can and cannot address

Signed-off-by: Abhijeet Kasurde [email protected]

ISSUE TYPE
  • Docs Pull Request

add a note stating what --start-at-task can and cannot address

Signed-off-by: Abhijeet Kasurde <[email protected]>
@Akasurde Akasurde requested review from bcoca and mkrizek July 19, 2024 17:36
.. note::

Moreover, ``--start-at-task``
- can target tasks **within** static includes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

within imports (which are static) .. dont say 'static includes' as that would be a contradiction in our terminology, in which all includes are dynamic

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same with below, just establish import == static/preprocessed, include ==dynamic/executed at runtime

Copy link
Contributor

@oraNod oraNod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Akasurde Hi, is this still something we should consider or is it better to close? I've taken a stab at the wording. Hopefully it helps. Cheers.

@@ -19,6 +19,14 @@ To start executing your playbook at a particular task (usually the task that fai

In this example, Ansible starts executing your playbook at a task named "install packages". This feature does not work with tasks inside dynamically re-used roles or tasks (``include_*``), see :ref:`dynamic_vs_static`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In this example, Ansible starts executing your playbook at a task named "install packages". This feature does not work with tasks inside dynamically re-used roles or tasks (``include_*``), see :ref:`dynamic_vs_static`.
In this example, Ansible starts executing your playbook at a task named "install packages".

@@ -19,6 +19,14 @@ To start executing your playbook at a particular task (usually the task that fai

In this example, Ansible starts executing your playbook at a task named "install packages". This feature does not work with tasks inside dynamically re-used roles or tasks (``include_*``), see :ref:`dynamic_vs_static`.

.. note::

Moreover, ``--start-at-task``
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Moreover, ``--start-at-task``
The ``--start-at-task`` feature does not work with reused tasks in all cases. This depends on if the reuse is dynamic or static.
- If dynamically reused with an ``include_*`` statement, ``--start-at-task`` can target the task itself but not tasks inside the included role or task.
- If statically reused with an ``import_*`` statement, ``--start-at-task`` can target tasks inside the imported role or task but not the task itself.
For more information about are inside roles or tasks (), see :ref:`dynamic_vs_static`.

@oraNod
Copy link
Contributor

oraNod commented Sep 12, 2024

Hi @Akasurde We've made some changes to the underlying readthedocs project for this repository. I'm going to close and re-open this issue to kick off a new PR preview build.

You might notice there will be two checks for readthedocs. One for docs/readthedocs.org:stage-ansible-core and another for docs/readthedocs.org:ansible-core.

The stage-ansible-core check is for the old project and will result in a 404. Please ignore that and use the ansible-core check only.

Thank you for your patience and understanding.

@oraNod oraNod closed this Sep 12, 2024
@oraNod oraNod reopened this Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants