search

maxheld83 / ghactions

GitHub actions for R and accompanying R package
https://www.maxheld.de/ghactions/
MIT License
169 stars 17 forks source link

link to or avoid duplication with ropensci book #376

Open maxheld83 opened 4 years ago

maxheld83 commented 4 years ago

https://github.com/ropenscilabs/actions_sandbox

orchid00 commented 4 years ago

hi @maxheld83 we were told that development of gh actions for R was moved to https://github.com/r-lib/actions/ ? if not what's the difference?

on the actions_sandbox, we were exploring actions, and made an effort to document examples. Please let us know if we can collaborate.

maxheld83 commented 4 years ago

absolutely, that is correct, r-lib/actions is the place to go. I'm still figuring out what to do with this package (ghactions), or whether to deprecate it entirely.

r-lib/actions includes yaml-templates for running GitHub actions.

r-lib/ghactions has a bunch of functions to write such yaml, in the usethis::use_*() style.

I'm actually not sure whether the latter approach still makes sense, since YAML is already supposed to be a human-readable format, and additional R wrappers on top will just include more sources for bugs/confusion. But perhaps they can be helpful.

What's your experience/opinion in this regard @orchid00 – is there a need for an R wrapper around writing GitHub Actions YAML?

orchid00 commented 4 years ago

hi @maxheld83 in my honestly very short experience with GitHub actions, I will recommend to add any actions that you created via the wrapper into "GH Marketplace" https://github.com/marketplace?type=actions . That way people can find them easily and add R specific actions via the uses tag in the YAML.

For example:

- uses: r-lib/actions/<SOMEACTIONNAME>
maxheld83 commented 4 years ago

thanks for the recommendation; I do have some actions on the marketplace, though the current iteration of this package includes no actions, but just writes out variants of existing actions.

orchid00 commented 4 years ago

Great! How do we find your actions? @maxheld83

If you are interested, maybe you can add your valuable experience into "Understanding what's going on in the yaml" https://ropenscilabs.github.io/actions_sandbox/understanding-yaml.html My thought is, as long as people understand what is included in the yaml file, they will be more likely to create their own action instructions.