search

nmfs-fish-tools / ghactions4r

Reusable github actions workflows for R packages
https://nmfs-fish-tools.github.io/ghactions4r/
12 stars 1 forks source link

[Feature]: Provide options for amount of setup that ghactions does for users #38

Closed k-doering-NOAA closed 8 months ago

k-doering-NOAA commented 2 years ago

Is your feature request related to a problem? Please describe.

A poll indicated that some people like when functions do everything for them (including messing with github settings, like creating new branches), while other prefer to only have functions create the setup files.

Describe the solution you would like.

Given there are different preferences, perhaps we should offer both options in workflows that rely on adjusting github settings (e.g., updating bookdown, updating pkgdown). I'm inclined to make the default the less invasive option of not adjusting github settings, but I could be persuaded otherwise.

Describe alternatives you have considered

Only providing one of the two options (currently, we only provide the file initialization without modifying github settings).

Additional context

No response

k-doering-NOAA commented 8 months ago

Perhaps the higher priority option is to document how to use the workflow (see #9) rather than providing both options. Both options will be harder to maintain.