make collection warning message clearer #74859
Conversation
ansibot
added
affects_2.12
bug
samdoran
removed
the
needs_triage
lib/ansible/cli/galaxy.py
Outdated
| "collections paths '%s'. The installed collection won't be picked up in an Ansible " | ||
| "run." % (to_text(path), to_text(":".join(collections_path)))) | ||
| "run, unless within a playbook adjacent collections directory." % (to_text(path), to_text(":".join(collections_path)))) |
There was a problem hiding this comment.
This wording doesn't really clarify the issue. It's probably easier to change the "won't" to "may".
There was a problem hiding this comment.
How does this sound?
The specified collections path '%s' is not part of the configured Ansible collections paths '%s'. The installed collection may not be picked up in an Ansible run, unless within a playbook adjacent collections directory.
There was a problem hiding this comment.
The phrase "unless within a playbook adjacent collections directory" is a mouthful. It's also not immediately apparent what that means unless the reader is well versed in Ansible jargon.
The specified collections path '%s' is not part of the configured Ansible collections paths '%s'. The installed collection may not be picked up in an Ansible run.
If there is a strong desire to mention adjacency (I know this was explicitly requested in the related issue, but I don't think it's the clearest phrasing), then something like this is probably best:
The specified collections path '%s' is not part of the configured Ansible collections paths '%s'. The installed collection will not be picked up in an Ansible run unless adjacent to a playbook.
ansibot
added
core_review
ansibot
added
the
stale_ci
ansibot
removed
the
stale_ci
|
Thanks @fchyla for the Ansible docs fix! |
SUMMARY
Fix for #74767 collection warning message
ISSUE TYPE
COMPONENT NAME
lib/ansible/cli
ADDITIONAL INFORMATION
Make the warning message state clearer and state that it will pick up a collection if it's within a playbook adjacent directory.