Skip to content

Commit

Permalink
Expand comment to increase clarity
Browse files Browse the repository at this point in the history
Expand comment to explicitly specify when it is possible to specify
collections in the meta/requirements.yml file.  Also add some links to
some Ansible documentation that describes the syntax for listing role
and collection dependencies.
  • Loading branch information
jsf9k committed Sep 20, 2023
1 parent 1666745 commit cf99590
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions meta/requirements.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,29 @@
#
# It _is_ possible to list both collections and roles in this file,
# but unfortunately ansible-galaxy attempts to naively merge the
# dependencies listed in meta/main.yml with these. That means that
# both sets of dependencies must be lists. :(
# dependencies listed in meta/main.yml with these. That means that if
# the list of role dependencies in meta/main.yml is nonempty then this
# file _must also_ consist of a single list of roles. :(
#
# See also cisagov/skeleton-ansible-role#153.
# That said, if the list of role dependencies in meta/main.yml is
# empty, and you want to specify collection dependencies in this file,
# then you can use the following syntax:
# collections:
# - name: namespace.name
# signatures:
# - https://examplehost.com/detached_signature.asc
# - file:///path/to/local/detached_signature.asc
# type: galaxy
# version: 1.0.0
#
# roles:
# - name: role_name
# scm: git
# src: [email protected]:mygroup/ansible-base.git
# version: 1.2.3
#
# See also:
# - cisagov/skeleton-ansible-role#153
# - https://galaxy.ansible.com/docs/using/installing.html#installing-multiple-roles-from-a-file
# - https://docs.ansible.com/ansible/devel/collections_guide/collections_installing.html#install-multiple-collections-with-a-requirements-file
[]

0 comments on commit cf99590

Please sign in to comment.