Installs YAML templates for various CI providers. These functions are also used within use_tic().

If you want to update an existing template use update_yml().

use_travis_yml(type = "linux-macos-deploy-matrix", write = TRUE, quiet = FALSE)

use_appveyor_yml(type = "windows", write = TRUE, quiet = FALSE)

use_circle_yml(type = "linux-matrix-deploy", write = TRUE, quiet = FALSE)

use_ghactions_yml(
  type = "linux-macos-windows-deploy",
  write = TRUE,
  quiet = FALSE
)

Arguments

type

[character]
Which template to use. The string should be given following the logic <platform>-<action>. See details for more.

write

[logical]
Whether to write the template to disk (TRUE) or just return it (FALSE).

quiet

[logical]
Whether to print informative messages.

pkgdown

If type contains "deploy", tic by default also sets the environment variable BUILD_PKGDOWN=true. This triggers a call to pkgdown::build_site() via the do_pkgdown macro in tic.R for the respective runners.

If a setting includes "matrix" and builds on multiple R versions, the job building on R release is chosen to build the pkgdown site.

YAML Type

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

Special types are custom and custom-deploy. These should be used if the runner matrix is completely user-defined. This is mainly useful in update_yml().

For backward compatibility use_ghactions_yml() will be default build and deploy on all platforms.

Here is a list of all available combinations:

ProviderOperating systemDeploymentmultiple R versionsCall
TravisLinuxnonouse_travis_yml("linux")
Linuxyesnouse_travis_yml("linux-deploy")
Linuxnoyesuse_travis_yml("linux-matrix")
Linuxyesyesuse_travis_yml("linux-deploy-matrix")
macOSnonouse_travis_yml("macos")
macOSyesnouse_travis_yml("macos-deploy")
macOSnoyesuse_travis_yml("macos-matrix")
macOSyesyesuse_travis_yml("macos-deploy-matrix")
Linux + macOSnonouse_travis_yml("linux-macos")
Linux + macOSyesnouse_travis_yml("linux-macos-deploy")
Linux + macOSnoyesuse_travis_yml("linux-macos-matrix")
Linux + macOSyesyesuse_travis_yml("linux-macos-deploy-matrix")
----------------------------------------------------------------------------------------------------------------------
CircleLinuxnonouse_circle_yml("linux")
Linuxyesnouse_travis_yml("linux-deploy")
Linuxnoyesuse_travis_yml("linux-matrix")
Linuxnoyesuse_travis_yml("linux-deploy-matrix")
----------------------------------------------------------------------------------------------------------------------
AppveyorWindowsnonouse_appveyor_yml("windows")
Windowsnoyesuse_travis_yml("windows-matrix")
----------------------------------------------------------------------------------------------------------------------
GH ActionsLinuxnonouse_ghactions_yml("linux")
Linuxyesnouse_ghactions_yml("linux-deploy)
customnonouse_ghactions_yml("custom)
custom-deployyesnouse_ghactions_yml("custom-deploy)
macOSnonouse_ghactions_yml("macos)
macOSyesnouse_ghactions_yml("macos-deploy)
Windowsnonouse_ghactions_yml("windows)
Windowsyesnouse_ghactions_yml("windows-deploy)
Linux + macOSnonouse_ghactions_yml("linux-macos")
Linux + macOSyesnouse_ghactions_yml("linux-macos-deploy")
Linux + Windowsnonouse_ghactions_yml("linux-windows")
Linux + Windowsyesnouse_ghactions_yml("linux-windows-deploy")
macOS + Windowsnonouse_ghactions_yml("macos-windows")
macOS + Windowsyesnouse_ghactions_yml("macos-windows-deploy")
Linux + macOS + Windowsnonouse_ghactions_yml("linux-macos-windows")
Linux + macOS + Windowsyesnouse_ghactions_yml("linux-macos-windows-deploy")

See also

update_yml