publish_package

R Documentation

Run the publish-stage release workflow

Description

Verifies the recorded finalize handoff against the current repository state and, when explicitly requested, performs selected release actions such as creating and pushing the release tag or deploying the already-built website.

Usage

publish_package(
  release_version,
  root = ".",
  dry_run = FALSE,
  do_tag = FALSE,
  deploy_site = FALSE,
  verbose = interactive(),
  runner = .run_process,
  deployer = .deploy_publish_site
)

Arguments

release_version	Required release version to verify and publish.
root	Repository root directory.
dry_run	Logical scalar. If 'TRUE', verifies readiness without executing external release actions.
do_tag	Logical scalar. If 'TRUE', creates and pushes the release tag and current branch after verification passes.
deploy_site	Logical scalar. If 'TRUE', deploys the finalize-built website after verification passes.
verbose	Logical scalar. If 'TRUE', emits stage-level progress messages.
runner	Function used to execute child commands. This is primarily a test seam for tool tests.
deployer	Function used to deploy the built website. This is primarily a test seam for tool tests and future deployment-wrapper integration.

Details

CLI entry point: './tools/publish.R –help'

Value

A list describing the publish run, including the written record and summary paths, checks, warnings, and executed actions.

Examples

## Not run: 
publish_package(release_version = "1.0.0", dry_run = TRUE)
publish_package(release_version = "1.0.0", do_tag = TRUE)

## End(Not run)