From d7c03e9fdb8875e30bc02d3b5b88123d562c006b Mon Sep 17 00:00:00 2001 From: Alicia Cozine <879121+acozine@users.noreply.github.com> Date: Wed, 10 Jun 2020 15:22:01 -0500 Subject: [PATCH] Update testing collections to mention ansible-base versions (#69805) Co-authored-by: Alicia Cozine --- docs/docsite/rst/dev_guide/developing_collections.rst | 2 +- docs/docsite/rst/dev_guide/testing.rst | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/docsite/rst/dev_guide/developing_collections.rst b/docs/docsite/rst/dev_guide/developing_collections.rst index bdffc4bd5fa..5a8ca2032a4 100644 --- a/docs/docsite/rst/dev_guide/developing_collections.rst +++ b/docs/docsite/rst/dev_guide/developing_collections.rst @@ -531,7 +531,7 @@ The build process for docs.ansible.com will know where to find the module docs. Testing collections =================== -The main tool for testing collections is ``ansible-test``, Ansible's testing tool described in :ref:`developing_testing`. You can run several compile and sanity checks, as well as run unit and integration tests for plugins using ``ansible-test``. +The main tool for testing collections is ``ansible-test``, Ansible's testing tool described in :ref:`developing_testing`. You can run several compile and sanity checks, as well as run unit and integration tests for plugins using ``ansible-test``. When you test collections, test against the ansible-base version(s) you are targeting. You must always execute ``ansible-test`` from the root directory of a collection. You can run ``ansible-test`` in Docker containers without installing any special requirements. The Ansible team uses this approach in Shippable both in the ansible/ansible GitHub repository and in the large community collections such as `community.general `_ and `community.network `_. The examples below demonstrate running tests in Docker containers. diff --git a/docs/docsite/rst/dev_guide/testing.rst b/docs/docsite/rst/dev_guide/testing.rst index fbc716f4edd..68189b16be8 100644 --- a/docs/docsite/rst/dev_guide/testing.rst +++ b/docs/docsite/rst/dev_guide/testing.rst @@ -4,7 +4,7 @@ Testing Ansible *************** -.. contents:: Topics +.. contents:: :local: @@ -17,7 +17,7 @@ Ansible users who understand how to write playbooks and roles should be able to Read on to learn how Ansible is tested, how to test your contributions locally, and how to extend testing capabilities. -If you want to learn on how testing collections, you should read :ref:`testing_collections` +If you want to learn about testing collections, read :ref:`testing_collections` @@ -183,7 +183,7 @@ Example:: If the PR does not resolve the issue, or if you see any failures from the unit/integration tests, just include that output instead: - | This doesn't work for me. + | This change causes errors for me. | | When I ran this Ubuntu 16.04 it failed with the following: |