Commit 6190c141 authored by Andrea Bolognani's avatar Andrea Bolognani
Browse files

ci: Enable Cirrus CI integration



We use cirrus-run to trigger Cirrus CI jobs from GitLab CI jobs,
making it possible to extend our platform coverage to include
FreeBSD without having to maintain our own runners; additionally,
we'll be able to ditch Travis CI and, since results for Cirrus CI
jobs are reflected back to the GitLab CI jobs that triggered them,
we will be able to get all information from a single dashboard.

The FreeBSD and macOS job definitions can be improved further: for
example, we will want to enable caching to speed up builds, and
ultimately we should figure out a way to generate at least part of
them, notably the list of packages to be installed, using lcitool.
All of that will happen in later patches: for now, this is good
enough to start using Cirrus CI.
Signed-off-by: Andrea Bolognani's avatarAndrea Bolognani <abologna@redhat.com>
Reviewed-by: Erik Skultety's avatarErik Skultety <eskultet@redhat.com>
parent cfdceb97
......@@ -38,6 +38,29 @@ stages:
- master
- /^ci-full-.*$/
# Jobs that we delegate to Cirrus CI because they require an operating
# system other than Linux. These jobs will only run if the required
# setup has been performed on the GitLab account (see ci/README.rst).
.cirrus_build_default_job_template: &cirrus_build_default_job_definition
stage: native_build
image: registry.gitlab.com/libvirt/libvirt-ci/cirrus-run:master
script:
- cirrus-run ci/cirrus/$NAME.yml.j2
only:
variables:
- $CIRRUS_GITHUB_REPO
- $CIRRUS_API_TOKEN
.cirrus_build_extra_job_template: &cirrus_build_extra_job_definition
<<: *cirrus_build_default_job_definition
only:
variables:
- $CIRRUS_GITHUB_REPO
- $CIRRUS_API_TOKEN
refs:
- master
- /^ci-full-.*$/
# Default cross build jobs that are always run
.cross_build_default_job_template: &cross_build_default_job_definition
......@@ -109,6 +132,16 @@ x64-ubuntu-2004:
<<: *native_build_default_job_definition
image: quay.io/libvirt/buildenv-libvirt-ubuntu-2004:latest
x64-freebsd-12-build:
<<: *cirrus_build_default_job_definition
variables:
NAME: freebsd-12
x64-macos-1015-build:
<<: *cirrus_build_default_job_definition
variables:
NAME: macos-1015
# Cross compiled build jobs
......
==============
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.
.. _Cirrus CI GitHub app: https://github.com/marketplace/cirrus-ci
.. _Cirrus CI settings: https://cirrus-ci.com/settings/profile/
.. _Cirrus CI: https://cirrus-ci.com/
.. _MinGW: http://mingw.org/
.. _cirrus-run: https://github.com/sio/cirrus-run/
freebsd_instance:
image_family: freebsd-12-1
env:
CI_REPOSITORY_URL: {{ CI_REPOSITORY_URL }}
CI_COMMIT_REF_NAME: {{ CI_COMMIT_REF_NAME }}
CI_COMMIT_SHA: {{ CI_COMMIT_SHA }}
freebsd_12_task:
install_script:
- pkg install -y
augeas
autoconf
automake
avahi
bash
bash-completion
ca_root_nss
ccache
chrony
cppi
curl
cyrus-sasl
dbus
diskscrub
dnsmasq
fusefs-libs
gdb
gettext
gettext-tools
git
glib
gmake
gnutls
hal
libpcap
libpciaccess
libssh
libssh2
libtool
libxml2
libxslt
lsof
meson
ncurses
ninja
patch
perl5
pkgconf
polkit
py37-docutils
py37-flake8
py37-setuptools
py37-wheel
python3
qemu-utils
radvd
readline
screen
sudo
vim
yajl
clone_script:
- git clone --depth 100 "$CI_REPOSITORY_URL" .
- git fetch origin "$CI_COMMIT_REF_NAME"
- git reset --hard "$CI_COMMIT_SHA"
build_script:
- mkdir build
- cd build
- ../autogen.sh --prefix=$(pwd)/install-root
- gmake -j3
- gmake -j3 install
- gmake -j3 dist
osx_instance:
image: catalina-base
env:
CI_REPOSITORY_URL: {{ CI_REPOSITORY_URL }}
CI_COMMIT_REF_NAME: {{ CI_COMMIT_REF_NAME }}
CI_COMMIT_SHA: {{ CI_COMMIT_SHA }}
PATH: /usr/local/opt/gettext/bin:/usr/local/opt/ccache/libexec:/usr/local/opt/rpcgen/bin:$PATH
PKG_CONFIG_PATH: /usr/local/opt/libxml2/lib/pkgconfig
macos_1015_task:
install_script:
- brew install
autoconf
automake
ccache
docutils
glib
gnutls
libtool
libxml2
make
pkg-config
python
rpcgen
xz
yajl
clone_script:
- git clone --depth 100 "$CI_REPOSITORY_URL" .
- git fetch origin "$CI_COMMIT_REF_NAME"
- git reset --hard "$CI_COMMIT_SHA"
build_script:
- mkdir build
- cd build
- ../autogen.sh --prefix=$(pwd)/install-root
- gmake -j3
- gmake -j3 install
- gmake -j3 dist
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment