finalize_package

R Documentation

Run the finalize-stage package workflow

Description

Executes the recurring late-stage local release-preparation workflow, including integrity checks, non-mutating validation gates, package documentation, local website auditing, package URL auditing, tarball generation, and finalize handoff recording.

Usage

finalize_package(
  root = ".",
  strict = FALSE,
  confirmed_rhub_pass = FALSE,
  confirmed_visual_review = FALSE,
  verbose = interactive(),
  runner = .run_process,
  steps = NULL
)

Arguments

root	Repository root directory.
strict	Logical scalar. If 'TRUE', fail on any release gate.
confirmed_rhub_pass	Logical scalar. In strict mode, confirms that the external release checks have been run and passed.
confirmed_visual_review	Logical scalar. In strict mode, confirms that the final manual visual review has passed.
verbose	Logical scalar. If 'TRUE', emits progress messages.
runner	Function used to execute child commands. This is primarily a test seam for tool tests, which can inject a fake process runner to simulate 'git', 'Rscript', and other child-command results without running the full finalize workflow.
steps	Optional named list of step definitions. This is primarily a test seam for tool tests, which can inject a small synthetic finalize step set to exercise warning accumulation, strict-mode failure handling, and handoff writing without invoking the full toolchain.

Details

The finalize workflow expects ESLint to be available for handwritten JavaScript linting. The current official bootstrap command for repository setup is 'npm init @eslint/config@latest'.

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

Value

A list describing the finalize run, including any warning steps and the written handoff artifacts.

Examples

## Not run: 
finalize_package()
finalize_package(
  strict = TRUE,
  confirmed_rhub_pass = TRUE,
  confirmed_visual_review = TRUE
)

## End(Not run)