From 33e37966c98f9383c44637c4fdd797c4dbb80fd7 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Wed, 30 Apr 2025 09:00:15 +0200 Subject: [PATCH 1/4] collection_requirements: add requirements version specification recommendation --- .../collection_contributors/collection_requirements.rst | 7 ++++++- 1 file changed, 6 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 ba2f71aa5f3..487cc5ef17c 100644 --- a/docs/docsite/rst/community/collection_contributors/collection_requirements.rst +++ b/docs/docsite/rst/community/collection_contributors/collection_requirements.rst @@ -199,7 +199,12 @@ Example: `meta/runtime.yml ` building, they SHOULD be listed in corresponding files under the ``meta`` directory, specified in ``meta/execution-environment.yml``, and `verified `_. +If a collection has controller-side Python package and/or system package requirements, to allow easy :ref:`execution environment` building: + +* They SHOULD be listed in corresponding files under the ``meta`` directory, specified in ``meta/execution-environment.yml``, and `verified `_. +* The entries in the file SHOULD NOT have a version cap or be fixed. This means no ``<=x.x.x`` or ``==x.x.x`` entries, only ``>=x.x.x`` entries. No specified version at all is also allowed. + + * It helps prevent issues during the creation of execution environments, particularly when bundling collections that have conflicting versions of the same dependencies. For instance, if one collection requires a fixed version of a dependency while another requires a higher version of the same dependency, the build process will fail. See the `Collection-level dependencies guide `_ for more information and `collection_template/meta `_ directory content as an example. From eebed5a20f41b6049b329ac8a8a1093a136f5b4a Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Fri, 2 May 2025 11:58:09 +0200 Subject: [PATCH 2/4] Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Felix Fontein --- .../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 487cc5ef17c..7a0043ae3b4 100644 --- a/docs/docsite/rst/community/collection_contributors/collection_requirements.rst +++ b/docs/docsite/rst/community/collection_contributors/collection_requirements.rst @@ -202,7 +202,7 @@ meta/execution-environment.yml If a collection has controller-side Python package and/or system package requirements, to allow easy :ref:`execution environment` building: * They SHOULD be listed in corresponding files under the ``meta`` directory, specified in ``meta/execution-environment.yml``, and `verified `_. -* The entries in the file SHOULD NOT have a version cap or be fixed. This means no ``<=x.x.x`` or ``==x.x.x`` entries, only ``>=x.x.x`` entries. No specified version at all is also allowed. +* The entries in the file SHOULD NOT have a version cap or be fixed. This means no ``<=x.x.x`` or ``==x.x.x`` entries, only ``>=x.x.x`` entries, potentially combined with ``,!=x.x.x``. No specified version at all is also allowed. * It helps prevent issues during the creation of execution environments, particularly when bundling collections that have conflicting versions of the same dependencies. For instance, if one collection requires a fixed version of a dependency while another requires a higher version of the same dependency, the build process will fail. From 5861bc64d56c5669186e1588819fd76bdd8a64df Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Mon, 19 May 2025 08:57:00 +0200 Subject: [PATCH 3/4] Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> --- .../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 7a0043ae3b4..80d5fe02b0a 100644 --- a/docs/docsite/rst/community/collection_contributors/collection_requirements.rst +++ b/docs/docsite/rst/community/collection_contributors/collection_requirements.rst @@ -202,7 +202,7 @@ meta/execution-environment.yml If a collection has controller-side Python package and/or system package requirements, to allow easy :ref:`execution environment` building: * They SHOULD be listed in corresponding files under the ``meta`` directory, specified in ``meta/execution-environment.yml``, and `verified `_. -* The entries in the file SHOULD NOT have a version cap or be fixed. This means no ``<=x.x.x`` or ``==x.x.x`` entries, only ``>=x.x.x`` entries, potentially combined with ``,!=x.x.x``. No specified version at all is also allowed. +* The entries in the file SHOULD NOT have a version cap or be fixed. Entries like ``<=x.x.x`` or ``==x.x.x`` are not allowed. Only ``>=x.x.x`` entries (with or without ``,!=x.x.x``), or no specified version at all are allowed. * It helps prevent issues during the creation of execution environments, particularly when bundling collections that have conflicting versions of the same dependencies. For instance, if one collection requires a fixed version of a dependency while another requires a higher version of the same dependency, the build process will fail. From c6264aeb72016c8a5c13c81a68376e1348475a22 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Mon, 19 May 2025 08:57:06 +0200 Subject: [PATCH 4/4] Update docs/docsite/rst/community/collection_contributors/collection_requirements.rst Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> --- .../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 80d5fe02b0a..b88f9525bd3 100644 --- a/docs/docsite/rst/community/collection_contributors/collection_requirements.rst +++ b/docs/docsite/rst/community/collection_contributors/collection_requirements.rst @@ -204,7 +204,7 @@ If a collection has controller-side Python package and/or system package require * They SHOULD be listed in corresponding files under the ``meta`` directory, specified in ``meta/execution-environment.yml``, and `verified `_. * The entries in the file SHOULD NOT have a version cap or be fixed. Entries like ``<=x.x.x`` or ``==x.x.x`` are not allowed. Only ``>=x.x.x`` entries (with or without ``,!=x.x.x``), or no specified version at all are allowed. - * It helps prevent issues during the creation of execution environments, particularly when bundling collections that have conflicting versions of the same dependencies. For instance, if one collection requires a fixed version of a dependency while another requires a higher version of the same dependency, the build process will fail. + * This rule helps prevent issues during the creation of execution environments, particularly when bundling collections that have conflicting versions of the same dependencies. For instance, if one collection requires a fixed version of a dependency while another requires a higher version of the same dependency, the build process will fail. See the `Collection-level dependencies guide `_ for more information and `collection_template/meta `_ directory content as an example.