feat: Mention bump_version(check_default_branch = FALSE) in error m…

…essage (#812)
cynkra · Nov 21, 2024 · 0c102ad · 0c102ad
1 parent 3b372f6
commit 0c102ad
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/R/bump-version.R b/R/bump-version.R
@@ -10,7 +10,7 @@ bump_version_impl <- function(fledgeling,
   #' 1. Verify that the current branch is the main branch
   #'    if `check_default_branch = TRUE` (the default).
   if (check_default_branch) {
-    check_main_branch("bump_version()")
+    check_main_branch("bump_version()", "bump_version(check_default_branch = FALSE)")
   }
   #' 1. [update_news()], using the `which` argument.
   out <- update_news_impl(

diff --git a/R/utils-git.R b/R/utils-git.R
@@ -1,9 +1,10 @@
-check_main_branch <- function(reason) {
+check_main_branch <- function(reason, alternative = NULL) {
   if (get_branch_name() != get_main_branch()) {
     cli::cli_abort(
       c(
         x = "Must be on the main branch ({.val {get_main_branch()}}) for running {.code {reason}}.",
-        i = "Currently on branch {.val {get_branch_name()}}."
+        i = "Currently on branch {.val {get_branch_name()}}.",
+        i = if (!is.null(alternative)) "Consider running {.run {alternative}}."
       )
     )
   }

diff --git a/tests/testthat/_snaps/bump_version.md b/tests/testthat/_snaps/bump_version.md
@@ -102,6 +102,7 @@
       Error in `check_main_branch()`:
       x Must be on the main branch ("main") for running `bump_version()`.
       i Currently on branch "bla".
+      i Consider running `bump_version(check_default_branch = FALSE)`.
 
 # bump_version() errors well for wrong arguments