record upkeep year and use it for filtering checklist

NEWS.md

@@ -1,14 +1,18 @@
 # usethis (development version)
 
+* `use_tidy_upkeep_issue()` now records the year it is being run in the
+  `Config/usethis/upkeep` field in DESCRIPTION. If this value exists it is
+  furthermore used to filter the checklist when making the issue.
+
 ## Bug fixes and minor improvements
 
 * `use_package()` now decreases a package minimum version required when
   `min_version` is lower than what is currently specified in the DESCRIPTION
   file (@jplecavalier, #1957).
-  
+
 * `use_data()` now uses serialization version 3 by default. (@laurabrianna, #2044)
 
-* Reverse dependency checks are only suggested if they exist 
+* Reverse dependency checks are only suggested if they exist
   (#1817, @seankross).
 
 # usethis 3.0.0

R/upkeep.R

@@ -16,13 +16,13 @@
 #' @export
 #' @examples
 #' \dontrun{
-#' use_upkeep_issue(2023)
+#' use_upkeep_issue()
 #' }
 use_upkeep_issue <- function(year = NULL) {
   make_upkeep_issue(year = year, tidy = FALSE)
 }
 
-make_upkeep_issue <- function(year, tidy) {
+make_upkeep_issue <- function(year, last_year, tidy) {
   who <- if (tidy) "use_tidy_upkeep_issue()" else "use_upkeep_issue()"
   check_is_package(who)
 
@@ -41,7 +41,7 @@
 
   gh <- gh_tr(tr)
   if (tidy) {
-    checklist <- tidy_upkeep_checklist(year, repo_spec = tr$repo_spec)
+    checklist <- tidy_upkeep_checklist(last_year, repo_spec = tr$repo_spec)
   } else {
     checklist <- upkeep_checklist(tr)
   }
@@ -118,10 +118,12 @@
 
 #' @export
 #' @rdname tidyverse
-#' @param year Approximate year when you last touched this package. If `NULL`,
-#'   the default, will give you a full set of actions to perform.
-use_tidy_upkeep_issue <- function(year = NULL) {
-  make_upkeep_issue(year = year, tidy = TRUE)
+#' @param year Approximate year when you last touched this package. Default will
+#' use the recorded year of the last upkeep issue or, if missing, show the full
+#' checklist
+use_tidy_upkeep_issue <- function(year = last_upkeep_year()) {
+  make_upkeep_issue(year = NULL, last_year = year, tidy = TRUE)
+  record_upkeep_date(Sys.Date())
 }
 
 # for mocking
@@ -327,3 +329,15 @@
   file_exists(cc) &&
     any(grepl("# test environment", readLines(cc), ignore.case = TRUE))
 }
+
+last_upkeep_date <- function() {
+  as.Date(proj_desc()$get_field("Config/usethis/upkeep", "2000-01-01"), format = "%Y-%m-%d")
+}
+
+last_upkeep_year <- function() {
+  as.integer(format(last_upkeep_date(), "%Y"))
+}
+
+record_upkeep_date <- function(date) {
+  desc <- proj_desc_field_update("Config/usethis/upkeep", format(date, "%Y-%m-%d"))
+}

tests/testthat/_snaps/upkeep.md

@@ -60,50 +60,3 @@
 
       <sup>Created on 2023-01-01 with `usethis::use_tidy_upkeep_issue()`, using [usethis v1.1.0](https://usethis.r-lib.org)</sup>
 
-# upkeep bullets don't change accidentally
-
-    Code
-      writeLines(upkeep_checklist())
-    Output
-      * [ ] `usethis::use_readme_rmd()`
-      * [ ] `usethis::use_github_links()`
-      * [ ] `usethis::use_pkgdown_github_pages()`
-      * [ ] `usethis::use_tidy_description()`
-      * [ ] `usethis::use_package_doc()`
-      Consider letting usethis manage your `@importFrom` directives here. `usethis::use_import_from()` is handy for this.
-      * [ ] `usethis::use_testthat()`. Learn more about testing at <https://r-pkgs.org/tests.html>
-      * [ ] Align the names of `R/` files and `test/` files for workflow happiness. The docs for `usethis::use_r()` include a helpful script. `usethis::rename_files()` may be be useful.
-      * [ ] `usethis::use_code_of_conduct()`
-      * [ ] Add alt-text to pictures, plots, etc; see <https://posit.co/blog/knitr-fig-alt/> for examples
-
-      Set up or update GitHub Actions. \
-            Updating workflows to the latest version will often fix troublesome actions:
-      * [ ] `usethis::use_github_action('check-standard')`
-
-      <sup>Created on 2023-01-01 with `usethis::use_upkeep_issue()`, using [usethis v1.1.0](https://usethis.r-lib.org)</sup>
-
----
-
-    Code
-      writeLines(checklist)
-    Output
-      * [ ] `usethis::use_readme_rmd()`
-      * [ ] `usethis::use_github_links()`
-      * [ ] `usethis::use_pkgdown_github_pages()`
-      * [ ] `usethis::use_tidy_description()`
-      * [ ] `usethis::use_package_doc()`
-      Consider letting usethis manage your `@importFrom` directives here. `usethis::use_import_from()` is handy for this.
-      * [ ] `usethis::use_testthat(3)` and upgrade to 3e, [testthat 3e vignette](https://testthat.r-lib.org/articles/third-edition.html)
-      * [ ] Align the names of `R/` files and `test/` files for workflow happiness. The docs for `usethis::use_r()` include a helpful script. `usethis::rename_files()` may be be useful.
-      * [ ] Consider changing default branch from `master` to `main`
-      * [ ] Remove description of test environments from `cran-comments.md`.
-      See `usethis::use_cran_comments()`.
-      * [ ] Add alt-text to pictures, plots, etc; see <https://posit.co/blog/knitr-fig-alt/> for examples
-
-      Set up or update GitHub Actions. \
-            Updating workflows to the latest version will often fix troublesome actions:
-      * [ ] `usethis::use_github_action('check-standard')`
-      * [ ] `usethis::use_github_action('test-coverage')`
-
-      <sup>Created on 2023-01-01 with `usethis::use_upkeep_issue()`, using [usethis v1.1.0](https://usethis.r-lib.org)</sup>
-

tests/testthat/test-upkeep.R

@@ -1,6 +1,9 @@
 test_that("tidy upkeep bullets don't change accidentally", {
   create_local_package()
   use_mit_license()
+  expect_equal(last_upkeep_year(), 2000L)
+  record_upkeep_date(as.Date("2022-04-04"))
+  expect_equal(last_upkeep_year(), 2022L)
 
   local_mocked_bindings(
     Sys.Date = function() as.Date("2023-01-01"),