Create a GitHub action that builds a pkgdown site — gha_pkgdown_branch • pkgdev

The GitHub action created would deploy a pkgdown site of your package on the gh-pages branch.

Usage

gha_pkgdown_branch(
  pkg = ".",
  overwrite = TRUE,
  platform = "macOS",
  version = "latest"
)

Source

Arguments

pkg: Path to a (subdirectory of an) R package.
overwrite: Overwrite the action if it was already present.
platform: Platform to use for deploying the package. See Details
version: Version of the platform. See Details.

Value

A GitHub Action on <pkg>/.github/workflows.

Details

Check https://github.com/actions/runner-images to see the available options.

See also

gha_check_full()

Examples

# \dontrun{
# With Ubuntu 20.04
gha_pkgdown_branch(platform = "ubuntu", version = "20.04")
#> ✔ Adding "R-version" to .github/.gitignore.
#> Warning: cannot open file '/tmp/RtmpXg8X1K/file1ea942807fdb/.github/.gitignore': No such file or directory
#> Error in file(path, open = file_mode, encoding = "utf-8"): cannot open the connection
# }