ci: Add a README for the CI stuff and script to install CI fairy.

This commit is contained in:
Ryan Pavlik 2022-09-20 08:44:44 -05:00
parent e06608533f
commit b30cb135b1
3 changed files with 52 additions and 1 deletions

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

@ -0,0 +1,38 @@
# CI and Generated Stuff Readme
<!--
# Copyright 2018-2022 Collabora, Ltd. and the Monado contributors
#
# SPDX-License-Identifier: CC0-1.0
-->
We use the FreeDesktop
["CI Templates"](https://freedesktop.pages.freedesktop.org/ci-templates) to
maintain build containers using code in this repo, storing the images in GitLab
Registry. Our CI files (and some other files) are auto-generated from Jinja
templates and `config.yml`, using
[ci-fairy](https://freedesktop.pages.freedesktop.org/ci-templates/ci-fairy.html).
You can install it with:
<!-- do not break the following line, it is used in CI setup too, to make sure it works -->
```sh
python3 -m pip install git+https://gitlab.freedesktop.org/freedesktop/ci-templates@d5aa3941aa03c2f716595116354fb81eb8012acb
```
On Windows you will also need to have GNU make and busybox installed, such as with:
```pwsh
scoop install make busybox
```
To re-generate files, from the root directory, run:
```sh
make -f .gitlab-ci/ci-scripts.mk
```
If you really want to force rebuilding, you can build the clean target first:
```sh
make -f .gitlab-ci/ci-scripts.mk clean all
```

View file

@ -1,10 +1,12 @@
#!/bin/bash #!/bin/bash
# Copyright 2018-2021, Collabora, Ltd. and the Monado contributors # Copyright 2018-2022, Collabora, Ltd. and the Monado contributors
# SPDX-License-Identifier: BSL-1.0 # SPDX-License-Identifier: BSL-1.0
( (
cd $(dirname $0) cd $(dirname $0)
bash ./install-cross.sh bash ./install-cross.sh
# Using this script "follows the instructions" for some testing of our instructions.
bash ./install-ci-fairy.sh
) )
python3 -m pip install proclamation cmakelang python3 -m pip install proclamation cmakelang

11
.gitlab-ci/install-ci-fairy.sh Executable file
View file

@ -0,0 +1,11 @@
#!/bin/sh
# SPDX-License-Identifier: CC0-1.0
# SPDX-FileCopyrightText: 2018-2022 Collabora, Ltd. and the Monado contributors
# This runs the command in the README as an extra bit of continuous integration.
set -e
(
cd "$(dirname "$0")"
sh -c "$(grep '^python3 -m pip' README.md)"
)