• Stars
    star
    898
  • Rank 48,714 (Top 1.0 %)
  • Language
    JavaScript
  • License
    Creative Commons ...
  • Created over 4 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

GitHub Actions for the R community

GitHub Actions for the R language

R build status RStudio community

This repository stores GitHub Actions for R projects, which can be used to do a variety of CI tasks. It also has a number of example workflows which use these actions.

Getting started

See this blog post on the Tidyverse blog.

Releases and tags

We use major version tags to mark breaking changes in these actions. For the current version, please use the v2 tag, e.g.:

- uses: r-lib/actions/setup-r@v2

The v2 tag occasionally changes, to introduce non-breaking fixes and improvements. These changes use more fine-grained tags, e.g. v2.0.1. You can refer to these as well in your workflow files if you need to.

List of actions

  1. r-lib/actions/setup-r - Sets up R
  2. r-lib/actions/setup-r-dependencies - Installs packages declared in DESCRIPTION
  3. r-lib/actions/setup-renv - Installs packages from renv lockfile
  4. r-lib/actions/setup-pandoc - Sets up pandoc
  5. r-lib/actions/setup-tinytex - Sets up LaTeX with tinytex
  6. r-lib/actions/check-r-package - Runs R CMD check on an R package
  7. r-lib/actions/pr-fetch - Fetches changes of a PR associated with an event
  8. r-lib/actions/pr-push - Pushes changes to a PR associated with an event
  9. r-lib/actions/run-rchk - Runs rchk tests to detect memory protection errors in C source code

Other GitHub Actions for R projects

What's new?

See the v2 release notes. These notes are kept current with the changes in v2.

Examples

See the r-lib/actions/examples directory for a variety of example workflows using these actions.

Where to find help

If your build fails, and you are unsure of why, here are some useful strategies for getting help.

  1. Figure out what caused the error. Look for the first time the word 'error' appears in the build log. Quite often errors at the end of the log are caused by an earlier issue, so it is best to look for the root cause.
  2. Take advantage of GitHub's code search to find similar yaml files. Use 'path:.github/workflows' to restrict your search to GitHub Action workflow files and also include additional terms specific to your problem. e.g. If you need to figure out how to install geospatial libraries such as gdal, use a search like 'gdal path:.github/workflows'. If you want to restrict results only to GitHub Actions workflows that use R you can add search for '"setup-r" path:.github/workflows
  3. Open an issue on RStudio community about your problem. Be sure to link to the workflow file you are using and a failing build to help others help you.
  4. If your issue seems related to GitHub Actions, but is not specific to R, open an issue at the GitHub Actions Community page.
  5. If you have done all of the above and are absolutely sure there is a bug in one of the R specific actions listed above, check if there is an open issue about it in this repo. Look at the pinned issues at the top first! We pin issues that affect many people, and the issue discussions often contain workarounds.
  6. Otherwise open a new issue in this repo.

If using a general search engine or GitHub search about your problem/idea, please note that content published prior to the Fall 2019 is probably outdated because the beta version of GitHub Actions was different. More recent posts or answers could be outdated too since GitHub Actions evolve, so refer to GitHub Actions official docs in case of doubt (and to existing working workflows) and GitHub changelog.

Common questions

  1. Why are my builds with plots failing on macOS?

    You need to install XQuartz to do plotting with the default quartz device on macOS. This can be done by adding the following to your workflow.

    - if: runner.os == 'macOS'
      run: brew install --cask xquartz
  2. Why are my Windows builds failing with an error about configure.ac having CRLF line endings?

    On Windows, when your repo is checked out using git, the line endings are automatically changed to CRLF. R's check process specifically checks if the configure.ac file has these line endings, and will error if it does. To avoid this, add a .gitattributes file to the top level of your package with the following to configure git to always use LF line endings for this file:
    configure.ac text eol=lf

  3. How can I customize an action to run R code?

    The safest way is to add a step to your action, specifying Rscript {0} as the shell for that step. Here's an example from the bookdown action:

    - name: Build site
      run: bookdown::render_book("index.Rmd", quiet = TRUE)
      shell: Rscript {0}

Additional resources

License CC0 licensed

All examples in this repository are published with the CC0 license.

More Repositories

1

devtools

Tools to make an R developer's life easier
R
2,350
star
2

lintr

Static Code Analysis for R
R
1,145
star
3

httr

httr: a friendly http package for R
R
978
star
4

testthat

An R 📦 to make testing 😀
R
860
star
5

usethis

Set up commonly used 📦 components
R
809
star
6

pkgdown

Generate static html documentation for an R package
R
692
star
7

styler

Non-invasive pretty printing of R code
R
674
star
8

pak

A fresh approach to package installation
C
605
star
9

cli

Tools for making beautiful & useful command line interfaces
R
597
star
10

roxygen2

Generate R package documentation from inline R comments
R
574
star
11

rig

The R Installation Manager
Rust
503
star
12

rlang

Low-level API for programming with R
R
475
star
13

progress

Progress bar in your R terminal
R
450
star
14

R6

Encapsulated object-oriented programming for R
R
398
star
15

here

A simpler way to find your files
R
394
star
16

scales

Tools for ggplot2 scales
R
379
star
17

fs

Provide cross platform file operations based on libuv.
C
356
star
18

covr

Test coverage reports for R
R
327
star
19

rex

Friendly regular expressions for R.
R
323
star
20

crayon

🖍️ R package for colored terminal output — now superseded by cli
R
319
star
21

remotes

Install R packages from GitHub, GitLab, Bitbucket, git, svn repositories, URLs
R
313
star
22

memoise

Easy memoisation for R
R
312
star
23

lobstr

Understanding complex R objects with tools similar to str()
R
295
star
24

callr

Call R from R
R
282
star
25

waldo

Find differences between R objects
R
274
star
26

vctrs

Generic programming with typed R vectors
C
273
star
27

slider

Sliding Window Functions
R
272
star
28

zeallot

Variable assignment with zeal! (or multiple, unpacking, and destructuring assignment in R)
R
249
star
29

conflicted

An alternative conflict resolution strategy for R
R
242
star
30

bench

High Precision Timing of R Expressions
R
237
star
31

gmailr

Access the Gmail RESTful API from R.
R
231
star
32

processx

Execute and Control Subprocesses from R
C
227
star
33

asciicast

Turn R scripts into terminal screencasts
R
217
star
34

httr2

Make HTTP requests and process their responses. A modern reimagining of httr.
R
215
star
35

xml2

Bindings to libxml2
R
213
star
36

gh

Minimalistic GitHub API client in R
R
213
star
37

cpp11

cpp11 helps you to interact with R objects using C++ code.
C++
190
star
38

keyring

🔐 Access the system credential store from R
R
187
star
39

vdiffr

Visual regression testing and graphical diffing with testthat
C++
178
star
40

svglite

A lightweight svg graphics device for R
C++
177
star
41

pillar

Format columns with colour
R
172
star
42

withr

Methods For Temporarily Modifying Global State
R
167
star
43

ragg

Graphic Devices Based on AGG
C++
167
star
44

hugodown

Make websites with hugo and RMarkdown
R
164
star
45

ymlthis

write YAML for R Markdown, bookdown, blogdown, and more
R
162
star
46

rprojroot

Finding files in project subdirectories
R
147
star
47

coro

Coroutines for R
R
146
star
48

debugme

Easy and efficient debugging for R packages
R
142
star
49

available

Check if a package name is available to use
R
141
star
50

archive

R bindings to libarchive, supporting a large variety of archive formats
C++
139
star
51

ellipsis

Tools for Working with ...
R
138
star
52

gert

Simple git client for R
C
135
star
53

later

Schedule an R function or formula to run after a specified period of time.
C++
134
star
54

itdepends

R
133
star
55

rray

Simple Arrays
R
130
star
56

isoband

isoband: An R package to generate contour lines and polygons.
C++
130
star
57

fastmap

Fast map implementation for R
C++
128
star
58

prettyunits

Pretty, human readable formatting of quantities
JavaScript
125
star
59

desc

Manipulate DESCRIPTION files
R
121
star
60

tidyselect

A backend for functions taking tidyverse selections
R
120
star
61

gargle

Infrastructure for calling Google APIs from R, including auth
R
111
star
62

rcmdcheck

Run R CMD check from R and collect the results
R
109
star
63

evaluate

A version of eval for R that returns more information about what happened
R
106
star
64

prettycode

Syntax highlight R code in the terminal
R
99
star
65

sloop

S language OOP ⛵️
R
99
star
66

mockery

A mocking library for R.
R
98
star
67

revdepcheck

R package reverse dependency checking
R
95
star
68

clock

A Date-Time Library for R
R
94
star
69

pkgdepends

R Package Dependency Resolution
R
93
star
70

systemfonts

System Native Font Handling in R
C++
91
star
71

lifecycle

Manage the life cycle of your exported functions and arguments
R
91
star
72

gtable

The layout packages that powers ggplot2
R
84
star
73

commonmark

High Performance CommonMark and Github Markdown Rendering in R
C
83
star
74

askpass

Password Entry for R, Git, and SSH
R
82
star
75

rappdirs

Find OS-specific directories to store data, caches, and logs. A port of python's AppDirs
R
81
star
76

zip

Platform independent zip compression via miniz
C
81
star
77

tree-sitter-r

C
81
star
78

downlit

Syntax Highlighting and Automatic Linking
R
80
star
79

clisymbols

Unicode symbols for CLI applications, with fallbacks
R
75
star
80

sessioninfo

Print Session Information
R
72
star
81

ps

R package to query, list, manipulate system processes
C
71
star
82

pkgapi

Create a map of functions for an R package - WORK IN PROGRESS!
R
70
star
83

credentials

Tools for Managing SSH and Git Credentials
R
69
star
84

roxygen2md

Convert elements of roxygen documentation to markdown
R
68
star
85

sodium

R bindings to libsodium
R
66
star
86

backports

Reimplementations of Functions Introduced Since R-3.0.0
R
65
star
87

pkgbuild

Find tools needed to build R packages
R
65
star
88

cliapp

Rich Command Line Applications
R
61
star
89

webfakes

Fake web apps for HTTP testing R packages
C
60
star
90

generics

Common generic methods
R
58
star
91

diffviewer

HTML widget to visually compare files
JavaScript
56
star
92

liteq

Serverless R message queue using SQLite
R
56
star
93

pkgload

Simulate installing and loading a package
R
54
star
94

cachem

Key-value caches for R
R
53
star
95

carrier

Create standalone functions for remote execution
R
50
star
96

brio

Basic R Input Output
R
50
star
97

jose

Javascript Object Signing and Encryption for R
R
48
star
98

urlchecker

Run CRAN URL checks from older versions of R
R
45
star
99

pkgconfig

Private configuration for R packages
R
40
star
100

filelock

Cross platform file locking in R
R
39
star