Skip to content

Commit bed2f27

Browse files
authored
collection_requirements: add meta/execution-environments.yml (#871)
* collection_requirements: add requirements.txt and bindep.txt * Change * Fix * Update wrt recent builder docs update
1 parent d9e034c commit bed2f27

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ Your collection repository MUST have a ``README.md`` in the root of the collecti
156156

157157
meta/runtime.yml
158158
----------------
159+
159160
Example: `meta/runtime.yml <https://github.com/ansible-collections/collection_template/blob/main/meta/runtime.yml>`_
160161

161162
* The ``meta/runtime.yml`` MUST define the minimum version of Ansible which this collection works with.
@@ -165,6 +166,13 @@ Example: `meta/runtime.yml <https://github.com/ansible-collections/collection_te
165166

166167
.. _coll_module-reqs:
167168

169+
meta/execution-environment.yml
170+
------------------------------
171+
172+
If a collection has controller-side Python package and/or system package requirements, to allow easy `execution environment <https://ansible.readthedocs.io/en/latest/getting_started_ee/index.html>`_ building, they SHOULD be listed in corresponding files under the ``meta`` directory, specified in ``meta/execution-environment.yml``, and `verified <https://ansible.readthedocs.io/projects/builder/en/latest/collection_metadata/#when-installing-collections-using-ansible-galaxy>`_.
173+
174+
See the `Collection-level dependencies guide <https://ansible.readthedocs.io/projects/builder/en/latest/collection_metadata/#collection-level-dependencies>`_ for more information and `collection_template/meta <https://github.com/ansible-collections/collection_template/tree/main/meta>` directory content as an example.
175+
168176
Modules & Plugins
169177
------------------
170178

0 commit comments

Comments
 (0)