From c6c4f4efb61e0e5efa2956651c365d301291c218 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Mon, 7 Feb 2022 12:45:17 +0100 Subject: [PATCH 1/4] Expand checklist and clarify requirements --- collection_checklist.md | 3 +++ collection_requirements.rst | 5 +++++ 2 files changed, 8 insertions(+) diff --git a/collection_checklist.md b/collection_checklist.md index 944e9f3..66af0ce 100644 --- a/collection_checklist.md +++ b/collection_checklist.md @@ -33,8 +33,11 @@ Every comment should say whether the reviewer expects it to be addressed, or whe - [ ] collection dependencies must have a lower bound on the version which is at least 1.0.0, and are all part of the `ansible` package - [ ] `meta/runtime.yml` defines the minimal version of Ansible which the collection works with - [ ] has changelog, preferably with `changelogs/changelog.yaml` +- [ ] collection repository should not contain any large objects (binaries) comparatively to the current Galaxy tarball size limit of 20 MB like, for example, package installers for testing purposes +- [ ] collection repository should not contain any unnecessary files like, for example, temporary files created by development tools **Tests:** + - [ ] passed `ansible-test sanity` - [ ] if `test/sanity/ignore*.txt` exists, it does not contain error codes listed [here](https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst#ci-testing) - [ ] has CI tests up and running against each of the "major versions" of `ansible-base`/`ansible-core` that the collection supports diff --git a/collection_requirements.rst b/collection_requirements.rst index 86c4c30..d234fe2 100644 --- a/collection_requirements.rst +++ b/collection_requirements.rst @@ -47,6 +47,9 @@ Collections * The CoC MUST be linked from the ``README.md`` file, or MUST be present or linked from the ``CODE_OF_CONDUCT.md`` file in the collection root. * MUST be published to `Ansible Galaxy `_. +* SHOULD NOT contain any large objects (binaries) comparatively to the current Galaxy tarball size limit of 20 MB like, for example, package installers for testing purposes. +* SHOULD NOT contain any unnecessary files like, for example, temporary files created by development tools. +* MUST only contain objects that follow the :ref:`licensing rules`. Python Compatibility ==================== @@ -233,6 +236,8 @@ Module naming Modules that only gather information MUST be named ``_info``. Modules that return ``ansible_facts`` are named ``_facts`` and do not return non-facts. For more information, refer to the `Developing modules guidelines `_. +.. _Licensing: + Licensing ========= From a7251d72f0ce388493c01e4bc683b1d5785b9e00 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Wed, 16 Feb 2022 14:52:11 +0300 Subject: [PATCH 2/4] Update collection_checklist.md Co-authored-by: John R Barker --- collection_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/collection_checklist.md b/collection_checklist.md index 66af0ce..3ff8783 100644 --- a/collection_checklist.md +++ b/collection_checklist.md @@ -33,7 +33,7 @@ Every comment should say whether the reviewer expects it to be addressed, or whe - [ ] collection dependencies must have a lower bound on the version which is at least 1.0.0, and are all part of the `ansible` package - [ ] `meta/runtime.yml` defines the minimal version of Ansible which the collection works with - [ ] has changelog, preferably with `changelogs/changelog.yaml` -- [ ] collection repository should not contain any large objects (binaries) comparatively to the current Galaxy tarball size limit of 20 MB like, for example, package installers for testing purposes +- [ ] collection repository should not contain any large objects (binaries) comparatively to the current Galaxy tarball size limit of 20 MB. For example, package installers for testing purposes shouldn't be added." - [ ] collection repository should not contain any unnecessary files like, for example, temporary files created by development tools **Tests:** From 858468a83249d1590d115b54f0be3354721304b2 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Wed, 16 Feb 2022 14:52:34 +0300 Subject: [PATCH 3/4] Update collection_checklist.md Co-authored-by: John R Barker --- collection_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/collection_checklist.md b/collection_checklist.md index 3ff8783..4949a5d 100644 --- a/collection_checklist.md +++ b/collection_checklist.md @@ -34,7 +34,7 @@ Every comment should say whether the reviewer expects it to be addressed, or whe - [ ] `meta/runtime.yml` defines the minimal version of Ansible which the collection works with - [ ] has changelog, preferably with `changelogs/changelog.yaml` - [ ] collection repository should not contain any large objects (binaries) comparatively to the current Galaxy tarball size limit of 20 MB. For example, package installers for testing purposes shouldn't be added." -- [ ] collection repository should not contain any unnecessary files like, for example, temporary files created by development tools +- [ ] collection repository should not contain any unnecessary files like, for example, temporary files created by development tools. Temporary files MUST be added to `.gitignore`. **Tests:** From ba2f37acb15e5caeeaf85db64d2b85daf4a7762b Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Wed, 16 Feb 2022 14:54:08 +0300 Subject: [PATCH 4/4] Update collection_checklist.md --- collection_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/collection_checklist.md b/collection_checklist.md index 4949a5d..e54497e 100644 --- a/collection_checklist.md +++ b/collection_checklist.md @@ -33,7 +33,7 @@ Every comment should say whether the reviewer expects it to be addressed, or whe - [ ] collection dependencies must have a lower bound on the version which is at least 1.0.0, and are all part of the `ansible` package - [ ] `meta/runtime.yml` defines the minimal version of Ansible which the collection works with - [ ] has changelog, preferably with `changelogs/changelog.yaml` -- [ ] collection repository should not contain any large objects (binaries) comparatively to the current Galaxy tarball size limit of 20 MB. For example, package installers for testing purposes shouldn't be added." +- [ ] collection repository should not contain any large objects (binaries) comparatively to the current Galaxy tarball size limit of 20 MB. For example, package installers for testing purposes shouldn't be added. - [ ] collection repository should not contain any unnecessary files like, for example, temporary files created by development tools. Temporary files MUST be added to `.gitignore`. **Tests:**