External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-07-03 16:42:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
cbd7124f49
libvirt/ci
History
Erik Skultety cbd7124f49 ci: helper: Use the ArgumentDefaultsHelpFormatter help formatter 
This help formatter class reports the defaults we use for options
taking an argument.

Signed-off-by: Erik Skultety <eskultet@redhat.com>
Reviewed-by: Andrea Bolognani <abologna@redhat.com>
2021-03-19 10:58:51 +01:00
..
cirrus ci: Delete refresh scripts 2021-03-15 18:49:03 +01:00
containers ci: Delete refresh scripts 2021-03-15 18:49:03 +01:00
build.sh ci: Specify the shebang sequence for build.sh 2021-02-12 17:01:41 +01:00
helper ci: helper: Use the ArgumentDefaultsHelpFormatter help formatter 2021-03-19 10:58:51 +01:00
list-images.sh ci: Update build system integration 2020-06-11 19:06:53 +02:00
Makefile ci: Discourage users from using the Makefile directly 2021-03-15 18:49:03 +01:00
README.rst ci: Enable Cirrus CI integration 2020-06-10 10:30:56 +02:00

README.rst

CI for libvirt

This document provides some information related to the CI capabilities for the libvirt project.

Cirrus CI integration

libvirt currently supports three non-Linux operating systems: Windows, FreeBSD and macOS. Windows cross-builds can be prepared on Linux by using MinGW, but for both FreeBSD and macOS we need to use the actual operating system, and unfortunately GitLab shared runners are currently not available for either.

To work around this limitation, we take advantage of Cirrus CI's free offering: more specifically, we use the cirrus-run script to trigger Cirrus CI jobs from GitLab CI jobs so that the workaround is almost entirely transparent to users and there's no need to constantly check two separate CI dashboards.

There is, however, some one-time setup required. If you want FreeBSD and macOS builds to happen when you push to your GitLab repository, you need to

  • set up a GitHub repository for the project, eg. yourusername/libvirt. This repository needs to exist for cirrus-run to work, but it doesn't need to be kept up to date, so you can create it and then forget about it;

  • enable the Cirrus CI GitHub app for your GitHub account;

  • sign up for Cirrus CI. It's enough to log into the website using your GitHub account;

  • grab an API token from the Cirrus CI settings page;

  • in the CI/CD / Variables section of the settings page for your GitLab repository, create two new variables:

    • CIRRUS_GITHUB_REPO, containing the name of the GitHub repository created earlier, eg. yourusername/libvirt;
    • CIRRUS_API_TOKEN, containing the Cirrus CI API token generated earlier. This variable must be marked as Masked, because anyone with knowledge of it can impersonate you as far as Cirrus CI is concerned.

    Neither of these variables should be marked as Protected, because in general you'll want to be able to trigger Cirrus CI builds from non-protected branches.

Once this one-time setup is complete, you can just keep pushing to your GitLab repository as usual and you'll automatically get the additional CI coverage.