These GitHub actions are useful for running continuous integration tasks, narrowly defined, such as building, installing and checking.

Install Package Dependencies

This GitHub action installs R package dependencies from a DESCRIPTION at the repository root.

Notice that this action installs R packages with R package dependencies, not system dependencies.

Secrets

None.

Environment Variables

  • 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.

Arguments

None.

Example Usage

Caveats

No Caching

GitHub actions currently has no native caching support. For more information, read the vignette on performance.

Build a Package

This GitHub action builds an R Package expected at the repository root.

Secrets

None.

Environment Variables

  • 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.

Arguments

None.

Example Usage

action “Build Package” { uses = “r-lib/ghactions/actions/build@master” }

Check a Package

This GitHub action tests an R package at the repository root.

Secrets

None.

Environment Variables

  • 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.

Arguments

None.

Example Usage

Install a Package

This GitHub action installs an R source package from the repository root.

Secrets

None.

Environment Variables

  • 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.

Arguments

None.

Example Usage

action "Install Package" {
  uses = "r-lib/ghactions/actions/install@master"
}

Render Package Website With pkgdown

This GitHub action renders a documentation website for an R package at the repository root using pkgdown.

Secrets

None.

Environment Variables

  • 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.

Arguments

None.

Example Usage

action "Check Package" {
  uses = "r-lib/ghactions/actions/pkgdown@master"
}