deploy_site_netlify

R Documentation

Verify or deploy the finalize-built website using Netlify

Description

Provides a narrow repository-owned wrapper around the Netlify CLI for the built 'website/' artifact. In dry-run mode, it verifies local prerequisites, validates Netlify authentication, and confirms that the configured site id is available to the authenticated account without deploying.

Usage

deploy_site_netlify(
  root = ".",
  dry_run = FALSE,
  verbose = interactive(),
  runner = .run_process
)

Arguments

root	Repository root directory.
dry_run	Logical scalar. If 'TRUE', verifies Netlify readiness without performing a deployment.
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.

Details

This tool depends on the Netlify CLI plus 'NETLIFY_AUTH_TOKEN' for authentication and 'NETLIFY_SITE_ID' for the target site id. When 'NETLIFY_SITE_ID' is unset, the wrapper also accepts a linked local '.netlify/state.json'.

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

Value

A list describing the verified deploy inputs and whether a deployment was executed.

Examples

## Not run: 
deploy_site_netlify(dry_run = TRUE)
deploy_site_netlify()

## End(Not run)