summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorBen Boeckel <ben.boeckel@kitware.com>2021-11-19 20:29:13 -0500
committerBen Boeckel <ben.boeckel@kitware.com>2021-11-22 12:58:25 -0500
commitc0d8e42a0858ab649d3cdeb2bee7253cf5efdf9b (patch)
treee36f14f0750c4f6a5b9d40e4ae4425da15e15946 /Help
parent3c2fedfeafb5782ca1360e5be3a5f4d8692bd35c (diff)
downloadcmake-c0d8e42a0858ab649d3cdeb2bee7253cf5efdf9b.tar.gz
gitlab-ci: shorten job prefixes
This helps to maximize the amount of information visible in the GitLab web interface. Also document their meaning in the developer documentation and in the CI configuration file directly. See: https://gitlab.com/gitlab-org/gitlab/-/issues/8496
Diffstat (limited to 'Help')
-rw-r--r--Help/dev/review.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/Help/dev/review.rst b/Help/dev/review.rst
index 198e100a95..34796a1a33 100644
--- a/Help/dev/review.rst
+++ b/Help/dev/review.rst
@@ -324,6 +324,19 @@ Heavier jobs require a manual trigger to run:
* ``failed``: Restart jobs which have completed, but without success.
* ``completed``: Restart all completed jobs.
+
+In order to keep job names shorter and keep as much information visible on the
+GitLab web interface as possible, jobs have a short prefix which indicates
+what its main purpose is:
+
+ * ``b:`` jobs build CMake for the purposes of running the
+ test suite.
+ * ``l:`` jobs perform "linting" on the CMake source tree such as static
+ analysis.
+ * ``p:`` jobs perform preparatory tasks for use in other jobs.
+ * ``t:`` jobs perform testing of CMake.
+ * ``u:`` jobs upload other job results to permanent locations.
+
If the merge request topic branch is updated by a push, a new manual trigger
using one of the above methods is needed to start CI again.