Vignette re: how to update released site #2051
Conversation
| - Add "tidyverse/tidytemplate" to `Config/Needs/website` in DESCRIPTION, if | ||
| repo is owned by one of these orgs: tidyverse, r-lib, tidymodels, rstudio. |
There was a problem hiding this comment.
This is pretty specific to us.
| (if owning org is one of: tidyverse, r-lib, tidymodels, rstudio) | ||
| add "tidyverse/tidytemplate" to Config/Needs/website in DESCRIPTION |
There was a problem hiding this comment.
Again, pretty specific to us.
|
And let me pre-emptively apologize for not releasing usethis. That would have been nice, but in the grand scheme of things, it wouldn't make a huge difference here. |
Co-authored-by: Hadley Wickham <[email protected]>
| * Update to usethis >= v2.1.5.9000, maybe with | ||
| `pak::pak("r-lib/usethis")`. | ||
| * Check out your default branch and `git pull`. | ||
| * Call `usethis::use_pkgdown_github_pages()`. This is safe and a good idea even |
There was a problem hiding this comment.
Hmmm, I just discovered this isn't quite true. It can overwrite an existing _pkgdown.yml with different / less content. Of course, if you're using Git, this is no big deal because you can discard the changes, wholesale or selectively.
But I will look into whether this can be made "safer", quickly.
There was a problem hiding this comment.
Here's where use_pkgdown() started to overwrite existing _pkgdown.yml:
I guess it is hard to selectively make desired changes to existing _pkgdown.yml, i.e. to modify it vs overwrite it.
Maybe the best we can do is still recommend that our team does this, then they'll have to selectively keep/discard changes before they commit.
| git cherry-pick SHA | ||
| git checkout REF -- path/to/a/specific/file | ||
| ``` | ||
| * Push this branch, maybe using `usethis::pr_push()`. |
There was a problem hiding this comment.
If you create a PR, Github will warn you that it can't be automatically merged, but this seems to be ok?
There was a problem hiding this comment.
After doing this a few times, I just pushed the branch but didn't make the PR.
There was a problem hiding this comment.
Yeah I say this below, in the longer form, but I'll repeat "don't open the PR" here.
|
|
||
| If you're already up-to-speed, here's the checklist: | ||
|
|
||
| * Update to usethis >= v2.1.5.9000, maybe with |
There was a problem hiding this comment.
I think you could collapse these first eight bullet points to — make sure the development version of the site looks the way that you want it before embark on updating the released site.
| * Backport innovations from the future. Most likely candidates: | ||
| - `_pkgdown.yml` | ||
| - `.github/workflows/pkgdown.yaml` | ||
| - `Config/Needs/website` field of DESCRIPTION |
There was a problem hiding this comment.
Would be useful just include what you need here:
Config/Needs/website: tidyverse/tidytemplate
|
OK @hadley check again |
| - `README.Rmd` / `README.md`. Do you need `devtools::build_readme()`? | ||
| - Any fixes to released roxygen comments / docs, then `document()`. | ||
| - Any new vignettes or articles that apply to the released version. |
There was a problem hiding this comment.
I still think this is a bit aggressive; it's definitely more of an optional extra.
There was a problem hiding this comment.
I can't tell if "this" refers the vignette point or to all the 3 bullets (README, oxygen comments, vignettes). But I've edited best I can, given that.
(I am often updating README, for example, to get updated badges.)
| release. | ||
|
|
||
| Example for readr, whose latest release is 2.1.1: | ||
| `git checkout -b update-pkgdown-2-1-1 v2.1.1` |
There was a problem hiding this comment.
Maybe we should have a usethis helper for this? Then it could automatically push/pull?
There was a problem hiding this comment.
I guess it depends on whether this ends up feeling like a one-time thing for us.
|
This is ready for another look @hadley |
Closes #1950
I've tried to make this generally applicable / readable. But yes it is our team's Spring Cleaning that is the immediate motivation.
Maybe this gets merged and refined over the course of the week. Then when our Spring Cleaning is done, we can dial back some of the things that are specific to us.