use_travis_deploy: Setup deployment for Travis CI

View source: R/setup.R

use_travis_deployR Documentation

Setup deployment for Travis CI

Description

Creates a public-private key pair, adds the public key to the GitHub repository via github_add_key(), and stores the private key as an encrypted environment variable in Travis CI via travis_set_var(), possibly in a different repository. The tic companion package contains facilities for installing such a key during a Travis CI build.

Usage

use_travis_deploy(
  path = usethis::proj_get(),
  repo = get_repo_slug(remote),
  key_name_private = NULL,
  key_name_public = NULL,
  endpoint = get_endpoint(),
  remote = "origin",
  quiet = FALSE
)

Arguments

path

[string]
The path to the repository.

repo

[string]
The repository slug to use. Must follow the "user/repo" structure.

key_name_private

[string]
The name of the private key of the SSH key pair which will be created. If not supplied, "TRAVIS_DEPLOY_KEY" will be used.

key_name_public

[string]
The name of the private key of the SSH key pair which will be created. If not supplied, "Deploy key for Travis CI (<endpoint>)" will be used.

endpoint

[string]
Which Travis endpoint to use. Defaults to ".org". Accepted values are ".com" and ".org". Can be set globally via env var R_TRAVIS.

remote

[string]
The Github remote which should be used. Defaults to "origin".

quiet

If TRUE, console output is suppressed.


ropenscilabs/travis documentation built on May 18, 2022, 8:33 p.m.