search

mikeroswell / ratioScales

Development of ratio scales package for plotting
https://mikeroswell.github.io/ratioScales/
1 stars 1 forks source link

how should we build README.md from README.Rmd? #14

Open bbolker opened 1 year ago

bbolker commented 1 year ago

I see that README.Rmd got changed in 981eccea but I don't see how (other than running knit or render by hand, oh my!) we should know to update README.md (this could be part of a GH action I guess ... ??)

dushoff commented 1 year ago

@mikeroswell said that he thought it was done by actions at today's meeting. Maybe he can confirm.

bbolker commented 1 year ago

Doesn't seem that way ... ??

mikeroswell commented 1 year ago

I think the GH action (.github/workflows/render-rmarkdown.yaml) works now. Git may complain if you try to push without building the .md file first, but I think that's avoided with git commit --no-verify. If there are package changes but there's no change to the .rmd files, I don't think it will trigger a rebuild though. I bet the .yaml file could be re-written to run the action with every push pretty easily, if we think that's a good idea. FWIW, that rendering action (and specifically, installing the R package dependencies every time) takes approximately forever. Also, I think that the upshot might be that the pkgdown website is built before the rendering occurs. So there's more to work on.