pals icon indicating copy to clipboard operation
pals copied to clipboard

Add rworkflows

Open bschilder opened this issue 1 year ago • 1 comments

A shameless plug for my new R-package dedicated GitHub Action, rworkflows. It basically streamlines all the checking, website creation, and even adds GH-native containerisation (without any manual steps).

The way it creates documentation website is by running pkgdown::build_site() each time the workflow is triggered (i.e. whenver you make a push), and pushing it to a new branch called "gh-pages". This means you don't need to store the "docs" folder in the main branch anymore (or run manual updates).

I also added some things peripherally related to rworkflows:

  • Added some lines to the .Rbuildignore to avoid common pitfalls with GHA.
  • Added some badges to display the current status of the rworkflows GHA, and show off your impressive code coverage (currently at 93%+!).

Let me know if you have any questions or requests for further tweaks.

bschilder avatar Dec 31 '23 20:12 bschilder

All checks are passing now, except for the ubuntu-latest, but that's a GH permissions thing. Should resolve itself if the PR is merged.

bschilder avatar Jan 01 '24 19:01 bschilder

@kwstat just wanted to check in and see if this is of interest

bschilder avatar Jul 30 '24 14:07 bschilder

@bschilder

I want to be clear that I AM adopting rworkflows into my code. However, I am going to close the patch. The only reason I am rejecting the patch is because I have about 10 CRAN packages that I maintain, and I wanted to have the same use of rworkflows in all of them. So I used your ideas and just converted all 10 packages in the same day. So, thank you. Even though I did not accept the PR, it most certainly helped push me toward using rworkflows.

kwstat avatar Aug 20 '24 16:08 kwstat