Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eddelbuettel/r-travis

Tools for using R with Travis, GitHub Actions and other CI backends
https://github.com/eddelbuettel/r-travis

Last synced: 2 months ago
JSON representation

Tools for using R with Travis, GitHub Actions and other CI backends

Awesome Lists containing this project

README

        

## r-travis: CI for R at Travis, GitHub Actions, Azure Pipelines, ...

*Note:* This repository is **deprecated** in favour of [r-ci](https://github.com/eddelbuettel/r-ci)
which is a portable generalization suitable for GitHub Actions, Azure
Pipelines, Travi, and likely more. This repo and its script `run.sh` still
work, but updates will happen over at [r-ci](https://eddelbuettel.github.io/r-ci/).

This repository ~~is~~ was a maintained fork of the (now deprecated) original
[r-travis](https://github.com/craigcitro/r-travis) repository by Craig Citro et al. I was an early
[contributor to this project](https://github.com/craigcitro/r-travis/graphs/contributors), and quite
like its design and features -- so I have been keeping it around, maintained and extended it. It is
my 'go-to' CI setup for a few dozen repositories affecting a fairly decent number of users.

### Status

Maintained and used across Travis and GitHub Actions -- and also usable with
Azure Pipelines, locally using Docker, ...

Its main advantages as are _strong portability_ as well as _ease of use_ and _customizability_.

Note that as it is used beyond just one Continuous Integration (CI) backend, we decided to change
the name away from reflecting only one of the backends. So please see the
[r-ci](https://github.com/eddelbuettel/r-ci) for the continuation of this work.

### Basic Usage

A minimal example of use with Travis follows:

```sh
language: c
sudo: required
dist: focal

before_install:
- curl -OLs https://eddelbuettel.github.io/r-ci/run.sh && chmod 0755 run.sh
- ./run.sh bootstrap

install:
- ./run.sh install_deps

script:
- ./run.sh run_tests
```

This downloads the `run.sh` script, uses it to _bootstrap_ the test environment, then installs
dependencies via `install_deps` and finally runs tests. For a realistic but real example see _e.g._
[this .travis.yml file of package
digest](https://github.com/eddelbuettel/digest/blob/master/.travis.yml).

For another example, see package [tidyCpp](https://github.com/eddelbuettel/tidycpp/) which shows how
to use the `run.sh` script [with Travis
CI](https://github.com/eddelbuettel/tidycpp/blob/master/.travis.yml) as well as [with GitHub
Actions](https://github.com/eddelbuettel/tidycpp/blob/master/.github/workflows/R-CMD-check.yaml).

Numerous variations are possible: running 'test matrices' across macOS and Linux, using BSPM for
binaries (both of those [are used by
digest](https://github.com/eddelbuettel/digest/blob/master/.travis.yml), running with several g++
versions (as used by
[RcppSimdjson](https://github.com/eddelbuettel/rcppsimdjson/blob/master/.travis.yml), ...

We also use the same approach of downloading `run.sh` and invoking it for the different steps in
with GitHub Actions (_e.g._ for
[tidyCpp](https://github.com/eddelbuettel/tidycpp/blob/master/.github/workflows/R-CMD-check.yaml)). Similarly,
Azure Pipelines can be used (as was done by a test repo on Azure).

There are also other options of use with PPAs and more---for fullest details see the source of the
shell script `run.sh`.

### More

See the [webpage for r-travis](http://eddelbuettel.github.io/r-travis/) for more on this repo, and
the [webpage for r-ci](http://eddelbuettel.github.io/r-ci/) for more on its successor and
continuation.

### Author

Dirk Eddelbuettel (for this maintained fork)

Craig Citro, Kirill Mueller, Dirk Eddelbuettel, ... (for the original r-travis)