vignettes/pkg-dev/auto-commit.Rmd
auto-commit.Rmd
These GitHub actions are useful for automatically committing changes.
This GitHub action creates man/
documentation from roxygen comments in R/
scripts at the repository root using devtools.
R_LIBS
, a vector of paths prepended to existing .libPaths()
.
Defaults to R_LIBS_WORKFLOW
([$HOME](https://developer.github.com/actions/creating-github-actions/accessing-the-runtime-environment/#filesystem)/lib/R/library
) where they persist over the run of the workflow. All earlier or later actions that have R_LIBS_WORKFLOW
in their .libPaths()
can install to or load from this path.
For more details, read the vignette on action isolation.
Document R package.
Usage:
document.R [--before-code=<"stop"|"stash"|"commit">] [--after-code=<"stop"|"commit">]
Options:
--before-code=<"stash"|"commit"> passed to `ghactions::check_clean_tree()`. Otherwise throws an error.
--after-code=<"commit"> passed to `ghactions::auto_commit()`. Otherwise throws an error.