https://github.com/maxheld83/ghactions

GitHub actions for R and accompanying R package
https://github.com/maxheld83/ghactions

cicd continous-delivery continous-integration data-science devops github github-actions rstats setup

Last synced: 3 months ago
JSON representation

GitHub actions for R and accompanying R package

• Host: GitHub
• URL: https://github.com/maxheld83/ghactions
• Owner: maxheld83
• License: mit
• Created: 2019-01-28T13:16:10.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-12-11T13:20:10.000Z (about 4 years ago)
• Last Synced: 2024-10-17T15:52:52.110Z (4 months ago)
• Topics: cicd, continous-delivery, continous-integration, data-science, devops, github, github-actions, rstats, setup
• Language: R
• Homepage: https://www.maxheld.de/ghactions/
• Size: 74.4 MB
• Stars: 169
• Watchers: 7
• Forks: 17
• Open Issues: 143
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - maxheld83/ghactions - GitHub actions for R and accompanying R package (R)

README

        
# GitHub Actions for R 

[![Actions Status](https://github.com/maxheld83/ghactions/workflows/.github/workflows/main.yml/badge.svg)](https://github.com/maxheld83/ghactions/actions)

[![tic](https://github.com/maxheld83/ghactions/workflows/tic/badge.svg?branch=master)](https://github.com/maxheld83/ghactions/actions)

[![codecov](https://codecov.io/gh/maxheld83/ghactions/branch/master/graph/badge.svg)](https://codecov.io/gh/maxheld83/ghactions)

[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

[![CRAN status](https://www.r-pkg.org/badges/version/ghactions)](https://cran.r-project.org/package=ghactions)

[![License: MIT](https://img.shields.io/github/license/r-lib/ghactions.svg?style=flat)](https://opensource.org/licenses/MIT)

[GitHub Actions](https://github.com/features/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 `*.yml`s from R. 

  (Which isn't saying that *should* be doing that.)

## Installation

To install, run:

```r

remotes::install_github("maxheld83/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:

```r

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.