Skip to content

Commit

Permalink
collection_requirements: add meta/execution-environments.yml (ansible…
Browse files Browse the repository at this point in the history
…#871)

* collection_requirements: add requirements.txt and bindep.txt

* Change

* Fix

* Update wrt recent builder docs update
  • Loading branch information
Andersson007 authored and oraNod committed Feb 12, 2024
1 parent 55b3848 commit 5314af8
Showing 1 changed file with 8 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ Your collection repository MUST have a ``README.md`` in the root of the collecti

meta/runtime.yml
----------------

Example: `meta/runtime.yml <https://github.com/ansible-collections/collection_template/blob/main/meta/runtime.yml>`_

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

.. _coll_module-reqs:

meta/execution-environment.yml
------------------------------

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>`_.

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.

Modules & Plugins
------------------

Expand Down

0 comments on commit 5314af8

Please sign in to comment.