Skip to contents

Create a GitHub action that documents and checks your package

Source: R/gha_update_docs.R
gha_update_docs.Rd

The GitHub action created would document your package (see update_docs()), would check it and would deploy the package on a gh-pages branch.

Usage

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

Source

r-lib/actions

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 .github/workflows.

Details

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

See also

update_docs(), gha_pkgdown_branch()

Examples

# \dontrun{
# With Ubuntu 20.04
gha_update_docs(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
# }