
Welcome to post 54 in the
R4 series.
The topic of continuous integration has been a recurrent theme here
at the
R4 series. Post
#32
introducess
r-ci,
while post
#41
brings
r2u to
r-ci, but does not show a
matrix deployment. Post
#45
describes the updated
r-ci setup that is now
the default and contains a macOS and Ubuntu matrix, where the latter
relies on
r2u to keep
things fast, easy, reliable . Last but not least more recent post
#52
shares a trick for ensuring coverage reports.
Following
#45,
use of
r-ci at for
example GitHub Actions has seen steady use and very reliable
performance. With the standard setup, a vanilla Ubuntu setup is changed
into one supported by
r2u. This requires
downloading and installating a few Ubuntu packages, and has
generally been fairly quick on the order of around fourty
seconds. Now, the general variability of run-times for
identical
tasks in GitHub Actions is well documented by the results of the
setup described in post
#39
which still runs weekly. It runs the identical SQL query against a
remote backend using two different package families. And lo and behold,
the intra-method variability on
unchanged code or setup and
therefore due solely to system variability is about as large as the
inter-method variability. In short, GitHub Actions performance varies
randomly with significant variability. See the
repo README.md for
chart that updates weekly (and see
#39
for background).
Of late, this variability became more noticeable during standard
GitHub Actions runs where it would regularly take more than two minutes
of setup time before actual continuous integration work was done. Some
caching seems to be in effect, so
subsequent runs in the same
repo seem faster and often came back to one minute or less. For
lightweight and small packages, loosing two minutes to setup when the
actual test time is a minute or less gets old fast.
Looking around, we noticed that container use can be combined with
matrix use. So we have now been deploying the following setup (not
always over all the matrix elements though)
jobs:
ci:
strategy:
matrix:
include:
- name: container, os: ubuntu-latest, container: rocker/r2u4ci
- name: macos, os: macos-latest
- name: ubuntu, os: ubuntu-latest
runs-on: $ matrix.os
container: $ matrix.container
GitHub Actions is smart enough to provide
NULL for
container in the two other cases, so
container: $ matrix.container is ignored there. But
when
container is set as here for the ci-enhanced version
of
r2u (which adds a few binaries commonly needed such as
git,
curl,
wget etc needed for
CI) then the CI jobs runs inside the container. And thereby skips most
of the setup time as the container is already prepared.
This also required some small adjustments in the underlying shell
script doing the work. To not disrupt standard deployment, we placed
these into a release candidate / development version one can op into
via an new variable
dev_version
- name: Setup
uses: eddelbuettel/github-actions/r-ci@master
with:
dev_version: 'TRUE'
Everything else remains the same and works as before. But faster as
much less time is spent on setup. You can see the actual full yaml file
and actions in my repositories for
rcpparmadillo and
rcppmlpack-examples.
Additional testing would be welcome, so feel free to deploy this in your
actions now. Otherwise I will likely carry this over and make it the
defaul in a few weeks time. It will still work as before
but when
the added container: line is used will run much faster
thanks to
rocker/r2u4ci being already set up for CI.
This post by Dirk
Eddelbuettel originated on his Thinking inside the box
blog. If you like this or other open-source work I do, you can now sponsor me at
GitHub.