Skip to content
GitHub actions for R and accompanying R package
R
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
R fix quotes Dec 1, 2019
man upgrade roxygen Nov 26, 2019
pkgdown/favicon add favicon, delete broken svg Feb 5, 2019
tests re-enable automatic deploy path closes #368 Dec 1, 2019
vignettes
.Rbuildignore enable azure pipelines Aug 20, 2019
.gitattributes supress diffs in rd files Oct 29, 2019
.gitignore
DESCRIPTION
LICENSE poke github actions May 10, 2019
NAMESPACE
README.md migrate to private account Jan 20, 2020
_pkgdown.yml separate out io and small fixes Oct 15, 2019
ghactions.Rproj
logo.png

README.md

GitHub Actions for R

Actions Status codecov lifecycle CRAN status License: MIT

GitHub Actions are a new workflow automation feature of the popular code repository host GitHub.

This package helps R users get started quickly with GitHub Actions:

  1. It provides workflow templates for common R projects (packages, RMarkdown, ...) with sensible defaults.
  2. It wraps and curates relevant existing external actions, such as those to deploy to GitHub Pages or Netlify.
  3. It exposes the GitHub Actions workflow syntax and lets you write GitHub Actions *.ymls from R. (Which isn't saying that should be doing that.)

Installation

To install, run:

remotes::install_github("r-lib/ghactions")

Because you're likely only to ever use it once, you need not take on ghactions as a dependency in your projects.

Quick Start

GitHub actions just requires a special file in a special directory at the root of your repository to work: .github/workflows/main.yml.

To quickly set up such a file for frequently used project kinds, run:

ghactions::use_ghactions(workflow = ghactions::website())

See the documentation for implied defaults and alternatives.

Then push to GitHub and go to the actions tab in your repository.

You can’t perform that action at this time.