actions icon indicating copy to clipboard operation
actions copied to clipboard

Setup "wizard"

Open hadley opened this issue 1 year ago • 6 comments

I wonder if it would be useful to have some sort of setup wizard (which would maybe live in usethis) that allowed you to pick:

  1. How to install R packages (e.g. DESCRIPTION, manifest, or renv)
  2. What you want to do (render quarto, render rmarkdown, run R script)
  3. How to publish (commit back to Git, github pages, connect cloud)

(Step one might go away eventually so depending on the timing we might not need to include it. ... Actually, even if we don't have a single action that can do any of the three, we can still detect locally so that the user doesn't need to select it. We can also filter down the options in 2 based on what file types are found.)

Then we'd slowly move the examples away from special case of R in production, reserving them for cases where all three pieces are roughly fixed (e.g. linting, documenting, checking).

hadley avatar Sep 30 '24 12:09 hadley

Yeah, IDK what the right place for this is. For renv people would need to add usethis to the renv project, which is not so great.

If we are already using pak for installation, and pak will get some form of the dependency detection code as well, then maybe this should go in pak as well.

gaborcsardi avatar Sep 30 '24 13:09 gaborcsardi

Hmmm the renv + usethis issue is an example of more general problem, so we might need to solve that at a higher level. (No idea what that solution would look like yet).

hadley avatar Sep 30 '24 14:09 hadley

I wonder how this should look. Should it be a set of helper functions that add goodies to a repo, like typical usethis functions do, or some project template kind of thing, rather?

gaborcsardi avatar Oct 01 '24 14:10 gaborcsardi

I was thinking it would be a usethis function that generated the workflow yaml for you

hadley avatar Oct 01 '24 18:10 hadley

So maybe we could transfer this issue to usethis?

gaborcsardi avatar Nov 08 '24 13:11 gaborcsardi

Yeah, I think that's probably the right place for it to live. But this repo might still need to publish the components as individual yaml snippets. But let's wait on this a bit longer to see what @thomasp85's work looks like.

hadley avatar Nov 08 '24 13:11 hadley