diff options
| author | Ben Boeckel <ben.boeckel@kitware.com> | 2021-11-20 01:29:13 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2021-11-23 15:11:25 (GMT) |
| commit | 7d5828e2933182e4bcd03fd32ad5cc4403b93694 (patch) | |
| tree | ab6e90392140b4dd30b407c4eb7b6a11993e9133 /Help/dev | |
| parent | cfa478e518049b6297ac874b1cf147d857e6ba7b (diff) | |
| download | CMake-7d5828e2933182e4bcd03fd32ad5cc4403b93694.zip CMake-7d5828e2933182e4bcd03fd32ad5cc4403b93694.tar.gz CMake-7d5828e2933182e4bcd03fd32ad5cc4403b93694.tar.bz2 | |
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/dev')
| -rw-r--r-- | Help/dev/maint.rst | 6 | ||||
| -rw-r--r-- | Help/dev/review.rst | 13 |
2 files changed, 16 insertions, 3 deletions
diff --git a/Help/dev/maint.rst b/Help/dev/maint.rst index 664b7a4..54d627d 100644 --- a/Help/dev/maint.rst +++ b/Help/dev/maint.rst @@ -245,12 +245,12 @@ Commit with a message such as:: Release versions do not have the development topic section of the CMake Release Notes index page. -Update ``.gitlab-ci.yml`` to drop the ``upload:`` jobs from the +Update ``.gitlab-ci.yml`` to drop the upload jobs from the packaging pipeline by renaming them to start in ``.``: .. code-block:: shell - sed -i 's/^upload:/.upload:/' .gitlab-ci.yml + sed -i 's/^u:/.u:/' .gitlab-ci.yml Commit with a message such as:: @@ -298,7 +298,7 @@ the version date from ``origin/master``: git checkout origin/master -- \ Source/CMakeVersion.cmake Help/release/dev/0-sample-topic.rst sed -i $'/^Releases/ i\\\n.. include:: dev.txt\\\n' Help/release/index.rst - sed -i 's/^\.upload:/upload:/' .gitlab-ci.yml + sed -i 's/^\.u:/u:/' .gitlab-ci.yml Update ``Source/CMakeVersion.cmake`` to set the version to ``$major.$minor.$date``: diff --git a/Help/dev/review.rst b/Help/dev/review.rst index 198e100..34796a1 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. |