Repository files navigation

This repository storesGitHub Actionsfor R projects, which can be used to do a variety of CI tasks. It also has anumber ofexample workflows which usethese actions.

Seethis blog post on the Tidyverse blog.

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

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

Thev2 tag occasionally changes, to introduce non-breaking fixes andimprovements. 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.

1. r-lib/actions/setup-r - Sets upR
2. r-lib/actions/setup-r-dependencies - Installs packages declared inDESCRIPTION
3. r-lib/actions/setup-renv - Installs packages from renv lockfile
4. r-lib/actions/setup-pandoc - Sets uppandoc
5. r-lib/actions/setup-tinytex - Sets up LaTeX withtinytex
6. r-lib/actions/check-r-package - RunsR 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/setup-manifest - Sets up an R project with a Posit Connectmanifest.json file

• quarto-dev/quarto-actions - Quarto related actions: install, render, publish

See thev2 release notes.These notes are kept current with the changes inv2.

See ther-lib/actions/examples directoryfor a variety of example workflows using these actions.

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 thefirst time the word'error' appears in the build log. Quite often errors at the end of the log are causedby an earlier issue, so it is best to look for the root cause.
2. Take advantage ofGitHub'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 asgdal, 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 onabout your problem. Be sure to link to the workflow file you are using and afailing build to help others help you.
4. If your issue seems related to GitHub Actions, but is not specific to R, open anissue at theGitHub ActionsCommunity page.
5. If you have done all of the above and areabsolutely sure there is a bugin one of the R specific actions listed above, check if there is an open issueabout itin this repo. Look at thepinned issues at the top first! We pin issues that affect many people, and theissue discussions often contain workarounds.
6. Otherwise open anew 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 toGitHub Actions official docs in case of doubt (and to existing working workflows) andGitHub changelog.

Your contributions are welcome! For new features, or if you are unsureabout a bug fix, please open issue before submitting a pull request.When submitting a pull request, please match the coding style of theexisting code. For any R code, please refer to theTidyverse style guide.For TypeScript and JavaScript code, you can runnpm run formatto standardize the code formatting.Adding a major feature also needs testing, typically by running aGHA workflow on the R package in this repository. Thank You!

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 aboutconfigure.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 theconfigure.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 astep to your action, specifyingRscript {0} as theshell for that step. Here's an example from thebookdown action:

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

• GitHub Actions for R, Jim Hester's talk at rstudio::conf 2020.Recording,slidedeck.
• GitHub Actions advent calendar a series of blogposts by Edward Thomson, one of the GitHub Actions product managershighlighting features of GitHub Actions.
• GitHub Actions with R - a short online book about using GitHub Actions with R, produced as part of therOpenSci OzUnconf.
• Awesome Actions - a curated list of custom actions.Note that many of these are from early in the GitHub Actions beta and may no longer work.

All examples in this repository are published with theCC0 license.