pkgdownDeployToAws: Deploy a pkgdown website to AWS S3 bucket

In acidgenomics/bb8: Acid Genomics Developer Tools

Deploy a pkgdown website to AWS S3 bucket

Description

Deploy a pkgdown website to AWS S3 bucket

Usage

pkgdownDeployToAws(
  package = getwd(),
  bucketDir = "s3://r.acidgenomics.com/packages/",
  clean = TRUE
)

Arguments

package	character. Directory path to R package. Parameterized, supporting building of multiple package websites in a single call.
bucketDir	character(1). AWS S3 bucket path.
clean	logical(1). Ensure pkgdown website build is clean, and also deleted after upload to AWS S3.

Value

logical. Whether individual pkgdown builds were successful, corresponding to input defined in package argument.

Note

Updated 2023-09-27.

Examples

## > pkgdownDeployToAws(
## >     package = file.path("~", "monorepo", "r-packages", "r-koopa")
## > )

acidgenomics/bb8 documentation built on Feb. 1, 2024, 11:38 a.m.