Protected branches

[krlmlr]

finalize_version() currently pushes to the main branch. Can we come up with a good workflow to support protected branches, i.e. if we want to disallow pushing things straight to production?

[krlmlr]

Currently, bump_version() fails for non-main branch:

library(fledge)

with_demo_project(quiet = TRUE, {
  usethis::use_r("bla")
  gert::git_add("R/bla.R")
  gert::git_commit("* Ad cool bla.")
  gert::git_branch_create("bump")
  bump_version()
})
#> Error in `check_main_branch()` at fledge/R/bump-version.R:6:2:
#> ! ✖ Must be on the main branch (main) for running fledge functions.
#> ℹ Currently on branch bump.

^{Created on 2022-05-12 by the reprex package (v2.0.1)}

We also need #31.

[krlmlr]

It's worth finding out if we can create a setting where fledge can run in GHA (and is allowed to push) but the branch is otherwise protected.

[krlmlr]

Added an argument to bump_version() to skip this check.

To avoid race conditions and incomplete NEWS.md files, we need to rethink how fledge operates in the scenario of protected branches. We need to separate the tagging (which can be made an almost atomic operation that is very likely to succeed) from creating NEWS.md, and do the tagging first. The new workflow would be:

Tagging

• Create a rich tag with the most recent news
  • Thin about already bumping the version in DESCRIPTION
• Push the tag

Updating NEWS.md (#31 ?)

• Compare NEWS.md and DESCRIPTION with the tags in the repo
• Populate NEWS.md and DESCRIPTION from the rich tags (not from the commits)
• Push to main/create a PR/...

Tweaking NEWS.md

At the user's convenience, manually, via PR.

Sync back tags (optional, #31)

• Read NEWS.md
• Update the rich tags where the contents differ through force-pushing (one by one)

API proposal

Names TBD.

• New function tag_from_history(push = TRUE)
• New function update_news_from_tag(check_main_branch = TRUE)
• bump_version() becomes tag_from_history() and update_news_from_tag()

CC @maelle.