[libvirt PATCH 2/7] docs: ci: Update the description on the integration CI GitLab variables

Erik Skultety posted 7 patches 2 years, 4 months ago
[libvirt PATCH 2/7] docs: ci: Update the description on the integration CI GitLab variables
Posted by Erik Skultety 2 years, 4 months ago
This patch mainly fixes an unfinished sentence that was supposed to
describe the LIBVIRT_CI_INTEGRATION_RUNNER_TAG variable, but took the
opportunity to update the description of the other variable too.

Signed-off-by: Erik Skultety <eskultet@redhat.com>
---
 docs/ci.rst | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/docs/ci.rst b/docs/ci.rst
index ee85018c49..f3911d84ca 100644
--- a/docs/ci.rst
+++ b/docs/ci.rst
@@ -31,8 +31,12 @@ see below.
 GitLab CI variables
 -------------------
 
-* ``LIBVIRT_CI_INTEGRATION`` - enables integration test runs manually or in forks
-* ``LIBVIRT_CI_INTEGRATION_RUNNER_TAG`` - overrides the upstream runner tag on the
+* ``LIBVIRT_CI_INTEGRATION`` - enables integration test suite execution as part
+    of the pipeline (works in forks too if there's a registered shared runner)
+* ``LIBVIRT_CI_INTEGRATION_RUNNER_TAG`` - overrides the gitlab-runner tag for
+    the pipeline; this is needed in forks because the default tag only matches
+    upstream shared runners which may be (and will be) different from the tags
+    defined on shared runners in forks
 
 Retrieving test logs
 --------------------
-- 
2.41.0