From f17da50b373dfd3a7a6cdcd6d4b4cf74298aad35 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Wed, 22 Jun 2022 08:23:27 +0200 Subject: [PATCH] Change requirements related to running tests against release commit (#206) * Change requirements related to running tests against release commit * Fix WF * Fix * Update collection_requirements.rst Co-authored-by: Felix Fontein * Fix formatting * Fix formatting * Cosmetic changes Co-authored-by: Felix Fontein --- .github/workflows/rstlint.yml | 2 +- collection_checklist.md | 8 ++++---- collection_requirements.rst | 8 ++++---- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/workflows/rstlint.yml b/.github/workflows/rstlint.yml index e9d791c..b82704a 100644 --- a/.github/workflows/rstlint.yml +++ b/.github/workflows/rstlint.yml @@ -19,4 +19,4 @@ jobs: sudo pip install rstcheck - name: run rstcheck - run: rstcheck --report error *.rst + run: rstcheck --report-level error *.rst diff --git a/collection_checklist.md b/collection_checklist.md index 511005d..1a8ef21 100644 --- a/collection_checklist.md +++ b/collection_checklist.md @@ -40,8 +40,8 @@ Every comment should say whether the reviewer expects it to be addressed, or whe **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) +- [ ] if `test/sanity/ignore*.txt` exists, it MUST 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 -- [ ] all CI tests run against every pull request -- [ ] all CI tests run against a commit that releases the collection; if they don't pass, the collection won't be released -- [ ] all CI tests run regularly (nightly, or at least once per week) +- [ ] all CI tests MUST run against every pull request +- [ ] all CI tests MUST run regularly (nightly, or at least once per week) +- [ ] sanity tests MUST run against a commit that releases the collection; if they don't pass, the collection won't be released diff --git a/collection_requirements.rst b/collection_requirements.rst index fd4c27e..b80c0ab 100644 --- a/collection_requirements.rst +++ b/collection_requirements.rst @@ -49,7 +49,7 @@ Collections * 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`. +* MUST only contain objects that follow the `Licensing rules `_. Python Compatibility ==================== @@ -337,10 +337,10 @@ CI Testing * Reviewers can block acceptance of a new collection if they don't agree with the ignores.txt entries. * You MUST run CI against each of the "major versions" (2.10, 2.11, 2.12, etc) of ``ansible-base``/``ansible-core`` that the collection supports. (Usually the ``HEAD`` of the stable-xxx branches.) - * All CI tests MUST run against every pull request and SHOULD pass before merge. -* All CI tests MUST pass for the commit that releases the collection. - +* At least sanity tests MUST run against a commit that releases the collection; if they do not pass, the collection will NOT be released. + + - If the collection has integration/unit tests, they SHOULD run too; if they do not pass, the errors SHOULD be analyzed to decide whether they should block the release or not. * All CI tests MUST run regularly (nightly, or at least once per week) to ensure that repositories without regular commits are tested against the latest version of ansible-test from each ansible-base/ansible-core version tested. The results from the regular CI runs MUST be checked regularly. All of the above can be achieved by using the `GitHub Action template `_.