External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-23 14:15:28 +00:00
Code Issues Packages Projects Releases Wiki Activity
6b08d4b37d
libvirt/ci
History
Andrea Bolognani d55547ec37 ci: Adapt to lcitool command line changes 
lcitool now uses the term "target" instead of "host" to refer to
the various operating systems it supports, and we need to adapt
our helper script so that it works with the new command line
interface.

Signed-off-by: Andrea Bolognani <abologna@redhat.com>
Reviewed-by: Erik Skultety <eskultet@redhat.com>
2021-08-04 09:52:28 +02:00
..
cirrus ci: refresh cirrus variables for FreeBSD python rename 2021-07-15 11:10:52 +01:00
containers ci: Drop CentOS 7 2021-05-05 13:25:21 +02:00
build.sh ci: Specify the shebang sequence for build.sh 2021-02-12 17:01:41 +01:00
helper ci: Adapt to lcitool command line changes 2021-08-04 09:52:28 +02:00
Makefile ci: helper: Rewrite image listing to Python 2021-03-19 11:47:26 +01:00
README.rst ci: README: Mention necessary step for cirrus to pick up the github project 2021-04-12 16:38:11 +02:00
util.py ci: util: Add a registry checker for stale images 2021-03-19 11:50:07 +01: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;

  • it may be necessary to push an empty .cirrus.yml file to your github fork for Cirrus CI to properly recognize the project. You can check whether Cirrus CI knows about your project by navigating to:

    https://cirrus-ci.com/yourusername/libvirt

  • 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.