Installs YAML templates for various CI providers.
use_travis_yml(type)use_appveyor_yml(type)
use_circle_yml(type)
[character]
Which template to use. The string should be given following the logic
<platform>-<action>. See details for more.
If a setting including "deploy" is selected, tic by default also adds
the environment var BUILD_PKGDOWN=true. This setting triggers a call
to pkgdown::build_site() via the do_pkgdown macro in tic.R.
If a setting includes "matrix" and builds on multiple R versions, the job building on R release is chosen to build the pkgdown site.
tic supports a variety of different YAML templates which follow the
<platform>-<action> pattern. The first one is mandatory, the
others are optional.
Possible values for <provider> are travis, and circle
Possible values for <platform> are linux, and macos, windows.
Possible values for <action> are matrix and deploy.
Not every combinations is supported on all CI systems.
For example, for use_appveyor_yaml() only windows and windows-matrix
are valid.
Here is a list of all available combinations:
| Provider | Operating system | Deployment | multiple R versions | Call |
| ---------- | ------------------ | ------------ | --------------------- | --------------------------------------------------------- |
| Travis | Linux | no | no | use_travis_yml("linux") |
| Linux | yes | no | use_travis_yml("linux-deploy") |
|
| Linux | no | yes | use_travis_yml("linux-matrix") |
|
| Linux | yes | yes | use_travis_yml("linux-deploy-matrix") |
|
| macOS | no | no | use_travis_yml("macos") |
|
| macOS | yes | no | use_travis_yml("macos-deploy") |
|
| macOS | no | yes | use_travis_yml("macos-matrix") |
|
| macOS | yes | yes | use_travis_yml("macos-deploy-matrix") |
|
| Linux + macOS | no | no | use_travis_yml("linux-macos") |
|
| Linux + macOS | yes | no | use_travis_yml("linux-macos-deploy") |
|
| Linux + macOS | no | yes | use_travis_yml("linux-macos-matrix") |
|
| Linux + macOS | yes | yes | use_travis_yml("linux-macos-deploy-matrix") |
|
| ---------- | ------------------ | ------------ | --------------------- | --------------------------------------------------------- |
| Circle | Linux | no | no | use_circle_yml("linux") |
| Linux | yes | no | use_travis_yml("linux-deploy") |
|
| Linux | no | yes | use_travis_yml("linux-matrix") |
|
| Linux | no | yes | use_travis_yml("linux-deploy-matrix") |
|
| ---------- | ------------------ | ------------ | --------------------- | --------------------------------------------------------- |
| Appveyor | Windows | no | no | use_appveyor_yml("windows") |
| Windows | no | yes | use_travis_yml("windows-matrix") |