Merge pull request #431 from lorenzwalthert/issue-421

Fix docs

Author: lorenzwalthert

NEWS.md

@@ -4,14 +4,20 @@ editor_options:
     wrap: 72
 ---
 
+# precommit v0.3.2.9000
+
+-   `use_ci()` is now documented to take `NA`, not `NULL` for argument
+    `ci` (#431).
+
 # precommit v0.3.2
 
 -   `parsable-R` hook now gives more context on where and how parsing
     fails (#423).
 -   fixed R CMD check issues in devel (#425).
 -   move from *experimental* to *stable* (#426).
 
-Thanks to [@danielinteractive](https://github.com/danielinteractive), [@jonocarroll](https://github.com/jonocarroll) for their contributions.
+Thanks to [\@danielinteractive](https://github.com/danielinteractive),
+[\@jonocarroll](https://github.com/jonocarroll) for their contributions.
 
 # precommit v0.3.1
 
@@ -40,7 +46,8 @@ Thanks to [@danielinteractive](https://github.com/danielinteractive), [&#
 -   All (R)md files in that repo are now formatted in a pandoc-compliant
     way (#415).
 
-Thanks to [@danielinteractive](https://github.com/danielinteractive) and [@mpadge](https://github.com/mpadge) for their contributions.
+Thanks to [\@danielinteractive](https://github.com/danielinteractive)
+and [\@mpadge](https://github.com/mpadge) for their contributions.
 
 # precommit v0.3.0
 

R/release.R

@@ -43,31 +43,25 @@ release_gh <- function(bump = "dev", is_cran = bump != "dev") {
   purrr::walk(path_template_config, update_rev_in_config,
     new_version = new_version
   )
-  last_release <- call_and_capture("git", "tag -l --sort=-taggerdate")$stdout[1]
 
+  last_release <- git_last_release()
   cli::cli_alert_success("Updated version in default config.")
-  msg1 <- glue::glue("Release {new_version}, see NEWS.md for details.")
-  msg2 <- glue::glue(
-    "Diff to previous release: ",
-    "https://github.com/lorenzwalthert/precommit/compare/",
-    "{last_release}...{new_version}"
-  )
   sys_call(
     "git",
     glue::glue(
       'commit DESCRIPTION {paste0(path_template_config, collapse = " ")} ',
-      '-m "{msg1}" -m "{msg2}"'
+      '-m "{release_msg1(last_release, new_version)}"'
     ),
     env = "SKIP=spell-check,consistent-release-tag"
   )
   cli::cli_alert_success("Committed DESCRIPTION and config template")
-  sys_call("git", glue::glue('tag -a {new_version} -m "{msg1}" -m "{msg2}"'))
+  if (!is_cran) {
+
+  }
   sys_call("./inst/hooks/local/consistent-release-tag.R", "--release-mode")
   cli::cli_alert_success("Tagged last commit with release version.")
   if (!is_cran) {
-    sys_call("git", glue::glue("push origin {new_version}"),
-      env = "SKIP=consistent-release-tag"
-    )
+    git_tag_release(last_release, new_version)
   }
 
   sys_call("git", glue::glue("push"),
@@ -84,6 +78,24 @@ release_gh <- function(bump = "dev", is_cran = bump != "dev") {
   }
 }
 
+git_tag_release <- function(last_release, new_version) {
+  sys_call("git", glue::glue('tag -a {new_version} -m "{release_msg(last_release, new_version)}"'))
+}
+
+git_last_release <- function() {
+  call_and_capture("git", "tag -l --sort=-taggerdate")$stdout[1]
+}
+
+release_msg <- function(last_release, new_version) {
+  glue::glue(
+    "Release {new_version}, see NEWS.md for details.\n\n",
+    "Diff to previous release: ",
+    "https://github.com/lorenzwalthert/precommit/compare/",
+    "{last_release}...{new_version}"
+  )
+}
+
+
 #' Complete the release
 #'
 #' Bumps the version to devel.
@@ -104,6 +116,9 @@ release_complete <- function(ask = TRUE, is_cran = ask, tag = NULL) {
     if (substr(tag, 1, 1) != "v") {
       rlang::abort("tag must start with v.")
     }
+    git_tag_release(
+      last_release = git_last_release(), new_version = tag
+    )
     sys_call("git", glue::glue("push origin {tag}"))
   }
   autoupdate() # only updates if tag is on the main branch

R/setup.R

@@ -77,7 +77,7 @@ use_precommit <- function(config_source = getOption("precommit.config_source"),
 #'   `"native"` on package loading (if unset). `"native"` sets up
 #'   [pre-commit.ci](https://pre-commit.ci). Alternatively, `"gha"` can be used
 #'   to set up [GitHub Actions](https://github.com/features/actions). Set value
-#'   to `NULL` if you don't want to use a continuous integration.
+#'   to `NA` if you don't want to use a continuous integration.
 #' @param force Whether or not to overwrite an existing ci config file (only
 #'   relevant for `ci = "gha"`).
 #' @param open Whether or not to open [pre-commit.ci](https://pre-commit.ci)