deploy: Deploy a bundle

In rstudio/connectapi: Utilities for Interacting with the 'Posit Connect' Server API

Deploy a bundle

Description

Deploys a bundle (tarball) to an Posit Connect server. If not provided, name (a unique identifier) will be an auto-generated alphabetic string. If deploying to an existing endpoint, you can set name or guid to the desired content.

Usage

deploy(
  connect,
  bundle,
  name = create_random_name(),
  title = name,
  guid = NULL,
  ...,
  .pre_deploy = {
 }
)

deploy_current(content)

Arguments

connect	A Connect object
bundle	A Bundle object
name	The unique name for the content on the server
title	optional The title to be used for the content on the server
guid	optional The GUID if the content already exists on the server
...	Additional arguments passed along to the content creation
.pre_deploy	An expression to execute before deploying the new bundle. The variables content and bundle_id are supplied
content	A Content object

Details

This function accepts the same arguments as connectapi::content_update().

deploy_current() is a helper to easily redeploy the currently active bundle for an existing content item.

Value

Task A task object

See Also

connectapi::content_update

Other deployment functions: bundle_dir(), bundle_path(), bundle_static(), download_bundle(), poll_task()

Examples

## Not run: 
client <- connect()

# beware bundling big directories, like `renv/`, `data/`, etc.
bnd <- bundle_dir(".")

deploy(client, bnd)

## End(Not run)


client <- connect(prefix = "TEST_1")
bnd <- bundle_path(system.file("tests/testthat/examples/static.tar.gz", package = "connectapi"))
deploy(client, bnd)

rstudio/connectapi documentation built on Dec. 20, 2024, 1:48 p.m.