From 936f4bda70bdc85b2aee1b9a6677b7c71c4179a6 Mon Sep 17 00:00:00 2001
From: Tristan van Berkom <tristan@codethink.co.uk>
Date: Thu, 17 Sep 2020 15:42:30 +0900
Subject: .gitlab-ci.yml: Added comment explaining how we test without
 `usedevelop`

---
 .gitlab-ci.yml | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to '.gitlab-ci.yml')

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 503195b66..267532a7d 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -211,6 +211,12 @@ tests-bb-remote-cache:
 
 tests-no-usedevelop:
   # Ensure that tests also pass without `--develop` flag.
+  #
+  # Our tox.ini file does not set `usedevelop` when running without coverage,
+  # but the `usedevelop` flag is required when collecting coverage information,
+  # this is why we provoke the tests to run with `nocover` in order to provoke
+  # the tests to run in CI without `usedevelop`.
+  #
   image: registry.gitlab.com/buildstream/buildstream-docker-images/testsuite-fedora:32-${DOCKER_IMAGE_VERSION}
   <<: *tests
   variables:
-- 
cgit v1.2.1