pkgdown icon indicating copy to clipboard operation
pkgdown copied to clipboard

Think about release workflow

Open hadley opened this issue 5 years ago • 6 comments

  • Release to CRAN
  • Tag commit — triggers build of main site
  • Blog about it
  • Add release blog post to releases
  • If mode: auto link to blog post only appears in dev version of site

hadley avatar Mar 14 '20 14:03 hadley

Another problem is if you build the NEWS soon after receiving the CRAN email, the NEWS page doesn't get a release date: https://pkgdown.r-lib.org/news/index.html#pkgdown-1-5-0-unreleased

hadley avatar Mar 25 '20 21:03 hadley

It's hacky but you can fix the NEWS issue on the v1.5.0 page by temporarily changing DESCRIPTION version to 1.5.0, rebuilding site, and using deploy_site_github().

This would add the blog post and update the "Unreleased" status on the v.1.5.0 NEWS page.

jayhesselberth avatar Mar 25 '20 22:03 jayhesselberth

Yeah, I was thinking more that we should engineer some solution that doesn't require the hack.

hadley avatar Mar 25 '20 22:03 hadley

For packages without an associated blog should there be support for NEWS pages & an RSS feed?

maelle avatar Feb 16 '21 11:02 maelle

@maelle that's out of scope I think.

hadley avatar Feb 16 '21 13:02 hadley

Too bad but understandable (given the existing tooling for building actual blogs). :grin:

maelle avatar Feb 16 '21 13:02 maelle

We have resolved this by making writing the blog post part of the pre-release process. In our experience, if you write the blog post after submitting to CRAN, you will inevitably discover some small problem that means you want to do a patch release. This is reflected in latest usethis::use_release_issue() checklists.

hadley avatar Apr 11 '24 21:04 hadley