Fix roles language in docs #25811
Merged
Fix roles language in docs #25811
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bcoca
reviewed
Jun 16, 2017
| name: foo | ||
| tags: | ||
| - bar | ||
| - baz | ||
|
|
||
| .. note:: | ||
| This *tags all of the tasks in that role with the tags specified*, overriding any tags that are specified inside the role. If you find yourself building a role with lots of tags and you want to call subsets of the role at different times, you should consider just splitting that role into multiple roles. | ||
| This *tags all of the tasks in that role with the tags specified*, appending to tags that are specified inside the role. If you find yourself building a role with lots of tags and you want to call subsets of the role at different times, you should consider just splitting that role into multiple roles. |
There was a problem hiding this comment.
this should be true for import, but include shoudl have tags applied to IT
There was a problem hiding this comment.
Not sure exactly what you mean by import vs include. So it's true for roles but not include_role?
There was a problem hiding this comment.
roles and import_role but not include_role
There was a problem hiding this comment.
Please amend to "any tags that are already specified inside the role". Thanks!
There was a problem hiding this comment.
I see: import_role is new. Much more explicit dynamic/static includes. Nice! Let me try to add that to the note without overcomplicating it.
ansibot
added
affects_2.4
samdoran
removed
the
needs_triage
samdoran
commented
Jun 16, 2017
| name: foo | ||
| tags: | ||
| - bar | ||
| - baz | ||
|
|
||
| .. note:: | ||
| This *tags all of the tasks in that role with the tags specified*, overriding any tags that are specified inside the role. If you find yourself building a role with lots of tags and you want to call subsets of the role at different times, you should consider just splitting that role into multiple roles. | ||
| This *tags all of the tasks in that role with the tags specified*, appending to any tags that are specified inside the role. The tags in this example will *not* be added to tasks inside an ``include_role``. Tag the ``include_role`` task directly in order to apply tags to tasks in included roles. If you find yourself building a role with lots of tags and you want to call subsets of the role at different times, you should consider just splitting that role into multiple roles. |
There was a problem hiding this comment.
This is rather tough to explain succinctly. Let me know if this is way too opaque.
|
Any objections before merging? |
ansibot
added
the
stale_ci
dharmabumstead
approved these changes
Jun 27, 2017
|
Thanks @samdoran! |
ansibot
added
docs
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Correct docs on how tags work on roles.
ISSUE TYPE
COMPONENT NAME
Docs
ANSIBLE VERSION
ADDITIONAL INFORMATION
Tags added at the role level are appended to task in a role and do not replace them.