Skip to contents

[Experimental]

Usage

deploy_stage(
  deploy_path = "deploy",
  docker_image_tag = tolower(golem::get_golem_name()),
  r_build =
    "rocker/r-ver:4.2.1@sha256:3e3f21d75482c5c66e122188ae88ad5c89ca24f5202dd07f69c623b3c8af7e80",
  use_renv = TRUE,
  copy_r_environ = TRUE,
  copy_r_profile = TRUE,
  copy_renv_lock = TRUE,
  copy_files = NULL,
  rebuild = TRUE,
  remove_previous_builds = TRUE,
  launch_job = TRUE,
  lockfile_path = "renv.lock",
  GITHUB_PAT = remotes:::github_pat()
)

Arguments

deploy_path

chr directory in which to stage deployment files

docker_image_tag

chr Docker Image tag name Default: tolower(golem::get_golem_name())

r_build

chr The name of the R build to use in the docker image. See the Rocker Hub for options.

use_renv

lgl whether to use the renv.lock & golem::add_dockerfile_with_renv (TRUE) or the DESCRIPTION golem::add_dockerfile

copy_r_environ

lgl Whether to include the .Renviron file

copy_r_profile

lgl Whether to include the .Rprofile file

copy_renv_lock

lgl Whether to include the renv.lock file

copy_files

chr vector of files to copy in addition to default.

rebuild

lgl Whether to rebuild the tar.gz

remove_previous_builds

lgl Whether to remove previous build files from deploy_path folder

launch_job

lgl whether to launch the deployment script jobs.R in the deploy_path directory after writing it.

GITHUB_PAT

chr Github Personal Access Token. ** Default remotes:::github_pat() **. Includes the Github Personal Access Token in .Renviron copied to Docker image for fetching Github repos during package installation. Set to NULL to turn off.

Value

job Background job that deploys the dmdu app (not working locally)

See also

Other deploy: deploy_tar()