Reference

Setup

Functions to help you get started with GitHub Actions.

edit_workflow()

Open configuration files

use_ghactions()

Workflow automation with GitHub Actions

use_ghactions_badge()

README badges

I/O

Reading and writing GitHub Actions from/to *.ymls.

write_workflow() r2yaml() read_workflows() read_workflow()

Reading and writing GitHub Actions workflow files

Workflows

Functions with GitHub Actions workflows for common R projects with sensible defaults.

website()

Render and deploy an rmarkdown project

Steps

Functions to write steps. This includes wrappers for external GitHub actions.

checkout()

Create a step to checkout a repository

ghpages() rsync() netlify() firebase()

Create an (action) step to deploy static assets

install_deps()

Create a step to install R package dependencies

rcmd_check() covr()

CI/CD steps for a package at the repository root

rscript()

Create a step to run utils::Rscript

Syntax

Functions to generate blocks of GitHub actions syntax. For internal purposes, not recommended for package users.

container()

Create nested list for the container field in job()

gh_matrix()

Create nested list for the matrix field in strategy()

ghactions_events

Supported events to trigger GitHub actions

ghactions_vms

Virtual machines available on GitHub Actions

job()

Create nested list for one job

on() on_push() on_pull_request() on_schedule()

Create nested list for an on: field

step()

Create nested list for one job

strategy()

Create nested list for the strategy field in job()

workflow()

Create nested list for a workflow block

Helpers

Helper functions.

is_github_actions()

Test whether the runtime is GitHub actions