Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

collection_requirements: add meta/execution-environments.yml #871

Merged
merged 4 commits into from
Jan 17, 2024
Merged

collection_requirements: add meta/execution-environments.yml #871

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
30817e3
collection_requirements: add requirements.txt and bindep.txt
Andersson007 Nov 28, 2023
276781e
Change
Andersson007 Dec 4, 2023
9138519
Fix
Andersson007 Dec 4, 2023
239652d
Update wrt recent builder docs update
Andersson007 Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/docsite/rst/community/collection_contributors/collection_requirements.rst
View file
Open in desktop
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