From 30817e3fa6a84a99b0bb3a852bd7868ee0ea4193 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Tue, 28 Nov 2023 11:09:54 +0100 Subject: [PATCH 1/4] collection_requirements: add requirements.txt and bindep.txt --- .../collection_requirements.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/docsite/rst/community/collection_contributors/collection_requirements.rst b/docs/docsite/rst/community/collection_contributors/collection_requirements.rst index 28e16ef9e41..f7d2c48c7a5 100644 --- a/docs/docsite/rst/community/collection_contributors/collection_requirements.rst +++ b/docs/docsite/rst/community/collection_contributors/collection_requirements.rst @@ -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 `_ * The ``meta/runtime.yml`` MUST define the minimum version of Ansible which this collection works with. @@ -165,6 +166,16 @@ Example: `meta/runtime.yml `_ building, they MUST be listed in the ``requirements.txt`` file in the collection's root directory. + +bindep.txt +---------- + +If a collection has controller-side system package requirements, to allow easy `execution environment `_ building, they MUST be listed in the ``bindep.txt`` file in the collection's root directory. + Modules & Plugins ------------------ From 276781e8fbbd8861ed424f061de24a30ae051d30 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Mon, 4 Dec 2023 09:06:22 +0100 Subject: [PATCH 2/4] Change --- .../collection_requirements.rst | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/docs/docsite/rst/community/collection_contributors/collection_requirements.rst b/docs/docsite/rst/community/collection_contributors/collection_requirements.rst index f7d2c48c7a5..250bbdd2a17 100644 --- a/docs/docsite/rst/community/collection_contributors/collection_requirements.rst +++ b/docs/docsite/rst/community/collection_contributors/collection_requirements.rst @@ -166,15 +166,10 @@ Example: `meta/runtime.yml `_ building, they MUST be listed in the ``requirements.txt`` file in the collection's root directory. - -bindep.txt ----------- +meta/execution-environment.yml +------------------------------ -If a collection has controller-side system package requirements, to allow easy `execution environment `_ building, they MUST be listed in the ``bindep.txt`` file in the collection's root directory. +If a collection has controller-side Python package and/or system package requirements, to allow easy `execution environment `_ building, they SHOULD be listed in the ``meta/execution-environment.yml`` and `verified `_. Modules & Plugins ------------------ From 91385197e9aac23c58d31382a8d9c4ea4c0d10ec Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Mon, 4 Dec 2023 09:51:48 +0100 Subject: [PATCH 3/4] Fix --- .../collection_contributors/collection_requirements.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/docsite/rst/community/collection_contributors/collection_requirements.rst b/docs/docsite/rst/community/collection_contributors/collection_requirements.rst index 250bbdd2a17..8af428fdc7e 100644 --- a/docs/docsite/rst/community/collection_contributors/collection_requirements.rst +++ b/docs/docsite/rst/community/collection_contributors/collection_requirements.rst @@ -169,7 +169,9 @@ Example: `meta/runtime.yml `_ building, they SHOULD be listed in the ``meta/execution-environment.yml`` and `verified `_. +If a collection has controller-side Python package and/or system package requirements, to allow easy `execution environment `_ building, they SHOULD be listed in corresponding files under the ``meta`` directory, specified in ``meta/execution-environment.yml``, and `verified `_. + +See the `collection_template/meta ` directory content as an example. Modules & Plugins ------------------ From 239652df6a5328cdbe7994e7751eb0ce8b63e2da Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Mon, 8 Jan 2024 09:23:25 +0100 Subject: [PATCH 4/4] Update wrt recent builder docs update --- .../collection_contributors/collection_requirements.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docsite/rst/community/collection_contributors/collection_requirements.rst b/docs/docsite/rst/community/collection_contributors/collection_requirements.rst index 8af428fdc7e..6db42f14b6b 100644 --- a/docs/docsite/rst/community/collection_contributors/collection_requirements.rst +++ b/docs/docsite/rst/community/collection_contributors/collection_requirements.rst @@ -171,7 +171,7 @@ meta/execution-environment.yml If a collection has controller-side Python package and/or system package requirements, to allow easy `execution environment `_ building, they SHOULD be listed in corresponding files under the ``meta`` directory, specified in ``meta/execution-environment.yml``, and `verified `_. -See the `collection_template/meta ` directory content as an example. +See the `Collection-level dependencies guide `_ for more information and `collection_template/meta ` directory content as an example. Modules & Plugins ------------------