Skip to contents

Propose snapshot

Source: R/propose_snapshot.R
propose_snapshot.Rd

Propose a Production snapshot of Staging.

Usage

propose_snapshot(
  path_staging,
  repo_staging = "https://staging.r-multiverse.org",
  types = c("src", "win", "mac"),
  r_versions = NULL,
  mock = NULL
)

Arguments

path_staging

Character string, directory path to the source files of the staging universe.

repo_staging

Character string, URL of the staging universe.

types

Character vector, what to pass to the types field in the snapshot API URL. Controls the types of binaries and documentation included in the snapshot.

r_versions

Character vector of major.minor versions of R to download binaries. For example, r_versions = c("4.4", "4.3"). Set to NULL to let R-universe choose default versions.

mock

For testing purposes only, a named list of data frames for inputs to various intermediate functions.

Value

NULL (invisibly). Called for its side effects. propose_snapshot() writes snapshot.json with an R-universe-like manifest of the packages recommended for the snapshot, and a snapshot.url file containing an R-universe snapshot API URL to download those packages. Both these files are written to the directory given by the path_staging argument.

Details

propose_snapshot() proposes a snapshot of Staging to migrate to Production. The recommended snapshot is the list of packages for which (1) the build and check results of the current release are in Staging, and (2) there are no issues. Writes snapshot.json with an R-universe-like manifest of the packages recommended for the snapshot, and a snapshot.url file containing an R-universe snapshot API URL to download those packages. Both these files are written to the directory given by the path_staging argument.

See also

Other staging: staging_is_active(), update_staging()

Examples

if (FALSE) { # \dontrun{
url_staging = "https://github.com/r-multiverse/staging"
path_staging <- tempfile()
gert::git_clone(url = url_staging, path = path_staging)
propose_snapshot(
  path_staging = path_staging,
  repo_staging = "https://staging.r-multiverse.org"
)
} # }