r-lib / usethis

Set up commonly used 📦 components

Home Page:https://usethis.r-lib.org/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

`use_release_issue()` changes

hadley opened this issue · comments

Based on our discussion at work week, I'd propose that we too new arguments/questions to use_release_issue(): use_pre_release and use_branch.

If use_pre_release is true, then we create two issues a pre-release (the current "prepare for release bullets), and then a release issue, which would gain new bullets for locking the main branch at the start and unlocking at the end.

If use_branch is true, the bullets would replace git pull and git push with (e.g.) pr_init("v1.4.1-release") and merging the PR. (We'd recommend that the PR close the issue automatically with a comment).

(For use_branch = TRUE we still need to think through the post-release process to ensure that both dev and releases sites are updated, and we end up with a dev version on the main branch.)

A couple more thoughts:

  • We probably want to keep use_prerelease = FALSE the default, since it only really affects bigger releases.
  • We might want to make use_branch = TRUE the default, since it's probably good practice for us even we can push directly to main.
  • We might want to move the check runs to the release process, because particularly when using a branch, we can update the version earlier, meaning that we'd move to 0 notes when everything was good.