tic (version 0.4.0)

use_tic: Initialize CI testing using tic

Description

Prepares a repo for building and deploying supported by tic. Depending on your choice of CI system, this function requires properly set up authentication with Travis CI and/or Circle CI. See vignette("travis", package = "travis") and vignette("circle", package = "circle") for details.

Usage

use_tic(
  wizard = interactive(),
  linux = "travis",
  mac = "travis",
  windows = "appveyor",
  deploy = "travis",
  matrix = "none",
  travis_endpoint = ".com",
  travis_key_name_private = NULL,
  travis_key_name_public = NULL,
  quiet = FALSE
)

Arguments

wizard

[flag] Interactive operation? If TRUE, a menu will be shown.

linux

[string] Which CI provider(s) to use to test on Linux. Possible options are "travis", "circle", "none" and "all".

mac

[string] Which CI provider(s) to use to test on macOS Possible options are "none", and "travis".

windows

[string] Which CI provider(s) to use to test on Windows Possible options are "none" and "appveyor".

deploy

[string] Which CI provider(s) to use to deploy artifacts such as pkgdown documentation. Possible options are "travis", "circle", "none" and "all".

matrix

[string] For which CI provider(s) to set up matrix builds. Possible options are "travis", "circle", "none" and "all".

travis_endpoint

[string] The Travis CI endpoint to use. Possible options are ".org" and ".com". Default is ".com". See travis::travis_enable() for more information.

travis_key_name_private

See travis::use_travis_deploy().

travis_key_name_public

See travis::use_travis_deploy().

quiet

[flag] Less verbose output? Default: FALSE.

Details

1. Query information which CI providers should be used

2. Setup permissions for providers selected for deployment

3. Create YAML files for selected providers

4. Create a default tic.R file depending on the repo type (package, website, bookdown, ...)

Examples

# NOT RUN {
# Requires interactive mode
if (FALSE) {
  use_tic()

  # Pre-specified settings favoring Circle CI:
  use_tic(
    wizard = FALSE,
    linux = "circle",
    mac = "travis",
    windows = "appveyor",
    deploy = "circle",
    matrix = "all"
  )
}
# }