gitlab-ci: add .gitlab-ci/README.md

This commit is contained in:
Thomas Haller 2023-06-06 12:32:23 +02:00
parent a8b2997fa5
commit fbbe81634f
No known key found for this signature in database
GPG key ID: 29C2366E4DFC5728

29
.gitlab-ci/README.md Normal file
View file

@ -0,0 +1,29 @@
.gitlab-ci
==========
We run tests in the gitlab-ci pipeline at
https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/pipelines
This directory contains a template for generating [.gitlab-ci.yml](../.gitlab-ci.yml).
It uses [ci-templates](https://gitlab.freedesktop.org/freedesktop/ci-templates/) project.
To get the right version of ci-templates, see the "Regenerate with" comment in
[.gitlab-ci.yml](../.gitlab-ci.yml). It shows how to install ci-fairy via
python pip. The exact version to be used is hard-coded as `.templates_sha`
variable in ci.template file.
Whenever changing relevant files, .gitlab-ci.yml must be regenerated.
Regenerate the yml by running `ci-fairy generate-template`.
There are also tests for checking that the yml is correct:
1) run `tools/check-gitlab-ci.sh`
2) run `make check-local-gitlab-ci`, which runs 1). This also
runs as part of `make check`.
In both cases, the test is skipped if `ci-fairy` is not in the path.
Install the correct `ci-fairy` version.
In gitlab-ci pipeline, the "check-tree" test also checks that .gitlab-ci.yml
is up to date.