run docs on push; deploy from main only

pharmaverse / examples

End to end examples of pharmaverse packages for common safety clinical reporting analyses

https://pharmaverse.github.io/examples/

Apache License 2.0

6 stars 6 forks source link

run docs on push; deploy from main only #60

Closed pawelru closed 5 months ago

pawelru commented 5 months ago

run docs for each PR
deploy only from main
remove steps conditional on tags as we don't do the tags here
update version of a few workflows

rossfarrugia commented 5 months ago

@bms63 @pawelru does this one still need merging? couldn't tell sorry from the slack chat

pawelru commented 5 months ago

Yes I think so. This would allow testing from the PR as opposed to merge blindly and wait for result from main. I think it's needed. We missed this somehow

rossfarrugia commented 5 months ago

OK thanks Pawel! As i'm still catching up post-holiday i tagged @bms63 here as reviewer to check he's happy and if so approve and merge.

bms63 commented 5 months ago

I'm happy to merge this in, but I'm not sure what it is doing.

I always think of docs as .Rd files but this does something with the site? Like it renders the site into a folder so we could take a look at it?

pawelru commented 5 months ago

It's because it's a quarto book with .qmd articles as opposed to package vignette in .Rmd. On default, Quarto renders your book into the _site subdirectory which then you can push to GH Pages (or not). This PR is just for include rendering process (but not deploy!) for each PR or feature branch. This way we can test changes before they go into the main branch and that's the whole point of this change. Currently everything is going to main without us knowing whether the book is renderable or not.

I'm going ahead and merge it. Please let me know if you encounter any difficulities in the PRs

bms63 commented 5 months ago

It's because it's a quarto book with .qmd articles as opposed to package vignette in .Rmd. On default, Quarto renders your book into the _site subdirectory which then you can push to GH Pages (or not). This PR is just for include rendering process (but not deploy!) for each PR or feature branch. This way we can test changes before they go into the main branch and that's the whole point of this change. Currently everything is going to main without us knowing whether the book is renderable or not.

I'm going ahead and merge it. Please let me know if you encounter any difficulities in the PRs

Hey @pawelru that makes sense. Thank you for explaining. Maybe a section in the Readme around actions would be a nice to have?