-
Notifications
You must be signed in to change notification settings - Fork 31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updated to GH Actions V2 #400
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving and disabling the build readme workflow. |
Just for completeness: Running the README workflow on our PRs before merging is basically our only (not overengineered) way to get up-to-date READMEs without making the main branch no longer write-protected. The README bot just can't push to main because of that. So I don't think it should be generally disabled, just only selectively run on PRs |
I think no one expressed an issue with having the README rendered with every PR. The issue was that when the rendered Adding to the checklist that the README be built was the solution that kept the rendered README update to date, and also allowed us to utilize the GH Actions to run the checks, and block merges from PRs with failing checks. |
Oh, okay! That sounds like it was a nightmare do find out :D Is this "done done"? Otherwise we could probably trigger the README workflow after everything else had been done |
I think @bailliem is making a few minor changes ahead of submitting to CRAN. I am not sure what you mean about triggering the workflow? We added to the checklist to manually build the README, so we won't need the workflow. Also the README build is in the CRAN submission checklist too. |
Oh okay, missed the manual build part |
Checklist for PR reviewer
_pkgdown.yml
pkgdown::build_site()
. Check the R console for errors, and review the rendered website.withr::with_envvar(new = c("NOT_CRAN" = "true"), covr::report())
. Before you run, begin a fresh R session without any packages loaded.usethis::use_spell_check()
runs with no spelling errors in documentationNEWS.md
been updated with the changes from this pull request under the heading indicating the latest version. If there is an issue associated with the pull request, reference it in parentheses at the end update (seeNEWS.md
for examples).usethis::use_version(which = "dev")