Mention not needing to source workspace before running tests (ros2#3677)

Signed-off-by: Christophe Bedard <christophe.bedard@apex.ai>
OTL · May 24, 2023 · 87a3bd9 · 87a3bd9
1 parent 0cfea83
commit 87a3bd9
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst b/source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst
@@ -231,6 +231,8 @@ To run tests for the packages we just built, run the following:
 
     You also need to specify ``--merge-install`` here since we used it for building above.
 
+.. _colcon-tutorial-source-the-environment:
+
 Source the environment
 ^^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/source/Tutorials/Intermediate/Testing/CLI.rst b/source/Tutorials/Intermediate/Testing/CLI.rst
@@ -14,6 +14,9 @@ To compile and run the tests, simply run the `test <https://colcon.readthedocs.i
 
 (where ``package_selection_args`` are optional package selection arguments for ``colcon`` to limit which packages are built and run)
 
+:ref:`Sourcing the workspace <colcon-tutorial-source-the-environment>` before testing should not be necessary.
+``colcon test`` makes sure that the tests run with the right environment, have access to their dependencies, etc.
+
 Examine Test Results
 ^^^^^^^^^^^^^^^^^^^^