Deploy a Package

Source: R/deploy.R

Deploy a Package

deploy_pkg(
  commit_msg = "deploy pkg using glitter",
  tag = NULL,
  remote_name = "origin",
  remote_branch = "master",
  install = TRUE,
  reset = FALSE,
  build_vignettes = FALSE,
  path = getwd(),
  ref = "HEAD",
  dependencies = NA,
  upgrade = "never",
  force = FALSE,
  quiet = FALSE,
  build = TRUE,
  build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"),
  build_manual = FALSE,
  repos = getOption("repos"),
  type = getOption("pkgType")
)

Arguments

commit_msg

commit message
remote_name

name of remote to push to. Defaults to "origin".
remote_branch

name of branch on the remote to push to. Defaults to "master" or "main" if the cardinal branch is using this newer default.
install

If TRUE, installs the package after the changes are pushed to the remote, Default: TRUE
reset

If TRUE, restart R after installation is complete. Default: TRUE.
path

full path to local repository to be pushed
description

description to extend the commit message if desired, Default: NULL

Value

A freshly packed local package committed to the remote that is by default also installed with vignettes, if applicable.

See also

document,build_vignettes,remote-reexports