Add collection_version lookup #3633
Conversation
felixfontein
force-pushed
the
check-collection
branch
from
bea326d
to
1bf4528
Compare
ansibullbot
added
integration
felixfontein
added
the
check-before-release
plugins/lookup/collection_version.py
Outdated
| else: | ||
| data = {} | ||
| galaxy_path = os.path.join(path, 'galaxy.yml') | ||
| galaxy_alt_path = os.path.join(path, 'galaxy.yaml') |
There was a problem hiding this comment.
As far as I can tell, galaxy.yaml was never a valid name for the collection metadata file (and git grep through ansible/ansible seems to confirm my suspicions). Maybe we can remove this line and simplify the code a bit?
There was a problem hiding this comment.
That's true for ansible-core 2.12 and Ansible 2.9, but ansible-base 2.10 and ansible-core 2.11 did support galaxy.yaml. Support was removed in ansible/ansible@595413d (see the changes in lib/ansible/galaxy/collection/__init__.py which are hidden by default). I'll add a comment to document that though.
There was a problem hiding this comment.
Documented in 1169b5a.
I can also remove this, or make this code only execute for 2.10 and 2.11. What do you think?
There was a problem hiding this comment.
I like this! As discussed in IRC I hope this would make its way to core too: ansible/community#631 (comment)
Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
ansibullbot
added
the
needs_revision
ansibullbot
removed
the
needs_revision
|
@rndmh3ro @tadeboro @briantist @agaffney thanks for reviewing and discussing this (resp. earlier versions)! |
felixfontein
removed
the
check-before-release
* Add collection_verison lookup plugin. * Document ansible-base 2.10 and ansible-core 2.11 special case. * Add default for result_not_found. * Simplify not existing test. * Move metadata loading to function. * Update plugins/lookup/collection_version.py Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com> * Extend tests. * Fix tests for ansible-core < 2.12. Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
SUMMARY
This lookup allows to query the version of a collection that's installed and loaded by the currently running Ansible version.
This can be useful in roles or playbooks that have to support a larger range of collection (or Ansible community package) versions, where backwards incompatible changes have been made, or where some operations can be optimized with new plugins/modules that are not available in all supported versions.
ISSUE TYPE
COMPONENT NAME
collection_version