Skip to content

Commit

Permalink
add new heading to readme
Browse files Browse the repository at this point in the history
try to clarify difference between usethis and ghactions4r
  • Loading branch information
k-doering-NOAA committed Jan 2, 2024
1 parent 2d794ec commit ea16bb4
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@

## What is in `{ghactions4r}`?

This repo contains a [collection of reusable workflows](https://github.com/nmfs-fish-tools/ghactions4r/tree/main/.github/workflows) found helpful for R packages. In addition, {ghactions4r} contains helper functions for setting up the workflows in a separate R package GitHub repository. Rather than having to maintain your own GitHub actions files (as you would need to with actions set up with [`usethis::use_github_action()`](https://usethis.r-lib.org/reference/use_github_action.html)), using a `{ghactions4r}` `use_*` function sets up a github actions file to directly call actions that exist and are maintained in the `{ghactions4r}` repository (in the [workflows folder](https://github.com/nmfs-fish-tools/ghactions4r/tree/main/.github/workflows)). This means all maintenance happens within the `{ghactions4r}` repository rather than in your repository!
This repo contains a [collection of reusable workflows](https://github.com/nmfs-fish-tools/ghactions4r/tree/main/.github/workflows) found helpful for R packages. In addition, {ghactions4r} contains helper functions for setting up the workflows in a separate R package GitHub repository.

## How is `{ghactions4r}` different than the `usethis::use_github_actions()` workflows?

Rather than having to maintain your own GitHub actions files (as you would need to with actions set up with [`usethis::use_github_action()`](https://usethis.r-lib.org/reference/use_github_action.html)), using a `{ghactions4r}` `use_*` function sets up a github actions file to directly call actions that exist and are maintained in the `{ghactions4r}` repository (in the [workflows folder](https://github.com/nmfs-fish-tools/ghactions4r/tree/main/.github/workflows)). This means all maintenance happens within the `{ghactions4r}` repository rather than in your repository!

## How do I use these workflows in my R package?

Expand Down

0 comments on commit ea16bb4

Please sign in to comment.