Create a GitHub Actions workflow that documents and checks your package

The GitHub Actions workflow documents your package (see update_docs()), checks it and deploys the package on a gh-pages branch.

Usage

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

Source

Examples from 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

Invisibly returns NULL after writing a GitHub Actions workflow to .github/workflows.

Details

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

See also

• update_docs() documents and checks your package.

• gha_check_full() creates a full package check action.

• gha_pkgdown_branch() creates a pkgdown deployment action.

GitHub Actions helpers: gha_check_full(), 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/RtmpbE1kC0/file1a0f13696044/.github/.gitignore': No such file or directory
#> Error in file(path, open = file_mode, encoding = "utf-8"): cannot open the connection
# }