Skip to content

Commit 5031980

Browse files
authored
Add some upkeep bullets (#1836)
* use_tidy_description() * Add section on updating GHA to upkeep checklist
1 parent 747931b commit 5031980

File tree

2 files changed

+20
-5
lines changed

2 files changed

+20
-5
lines changed

R/upkeep.R

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ upkeep_checklist <- function() {
5858
todo("`usethis::use_roxygen_md()`", !is_true(uses_roxygen_md())),
5959
todo("`usethis::use_github_links()`", !has_github_links()),
6060
todo("`usethis::use_pkgdown_github_pages()`", !uses_pkgdown()),
61+
todo("`usethis::use_tidy_description()`"),
6162
todo(
6263
"
6364
`usethis::use_package_doc()`
@@ -81,7 +82,6 @@ upkeep_checklist <- function() {
8182
Align the names of `R/` files and `test/` files for workflow happiness. \\
8283
The docs for `usethis::use_r()` include a helpful script. \\
8384
`usethis::rename_files()` may be be useful."),
84-
todo("`usethis::use_github_action('check-standard')`"),
8585
todo(
8686
"Consider changing default branch from `master` to `main`",
8787
git_default_branch() == "master"
@@ -93,8 +93,14 @@ upkeep_checklist <- function() {
9393
has_old_cran_comments()
9494
),
9595
todo("
96-
Add alt-text to pictures, plots, etc; see \\
97-
<https://posit.co/blog/knitr-fig-alt/> for examples")
96+
Add alt-text to pictures, plots, etc; see \\
97+
<https://posit.co/blog/knitr-fig-alt/> for examples"),
98+
"",
99+
"Set up or update GitHub Actions. \\
100+
Updating workflows to the latest version will often fix troublesome actions:",
101+
todo("`usethis::use_github_action('check-standard')`"),
102+
todo("`usethis::use_github_action('pkgdown')`", uses_pkgdown()),
103+
todo("`usethis::use_github_action('test-coverage')`", uses_testthat())
98104
)
99105

100106
c(bullets, upkeep_extra_bullets(), checklist_footer(tidy = FALSE))

tests/testthat/_snaps/upkeep.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,18 @@
7878
* [ ] `usethis::use_readme_rmd()`
7979
* [ ] `usethis::use_github_links()`
8080
* [ ] `usethis::use_pkgdown_github_pages()`
81+
* [ ] `usethis::use_tidy_description()`
8182
* [ ] `usethis::use_package_doc()`
8283
Consider letting usethis manage your `@importFrom` directives here. `usethis::use_import_from()` is handy for this.
8384
* [ ] `usethis::use_testthat()`. Learn more about testing at <https://r-pkgs.org/tests.html>
8485
* [ ] 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.
85-
* [ ] `usethis::use_github_action('check-standard')`
8686
* [ ] `usethis::use_code_of_conduct()`
8787
* [ ] Add alt-text to pictures, plots, etc; see <https://posit.co/blog/knitr-fig-alt/> for examples
8888
89+
Set up or update GitHub Actions. \
90+
Updating workflows to the latest version will often fix troublesome actions:
91+
* [ ] `usethis::use_github_action('check-standard')`
92+
8993
<sup>Created on DATE with `usethis::use_upkeep_issue()`, using [usethis vVERSION](https://usethis.r-lib.org)</sup>
9094

9195
---
@@ -97,15 +101,20 @@
97101
* [ ] `usethis::use_readme_rmd()`
98102
* [ ] `usethis::use_github_links()`
99103
* [ ] `usethis::use_pkgdown_github_pages()`
104+
* [ ] `usethis::use_tidy_description()`
100105
* [ ] `usethis::use_package_doc()`
101106
Consider letting usethis manage your `@importFrom` directives here. `usethis::use_import_from()` is handy for this.
102107
* [ ] `usethis::use_testthat(3)` and upgrade to 3e, [testthat 3e vignette](https://testthat.r-lib.org/articles/third-edition.html)
103108
* [ ] 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.
104-
* [ ] `usethis::use_github_action('check-standard')`
105109
* [ ] Consider changing default branch from `master` to `main`
106110
* [ ] Remove description of test environments from `cran-comments.md`.
107111
See `usethis::use_cran_comments()`.
108112
* [ ] Add alt-text to pictures, plots, etc; see <https://posit.co/blog/knitr-fig-alt/> for examples
109113
114+
Set up or update GitHub Actions. \
115+
Updating workflows to the latest version will often fix troublesome actions:
116+
* [ ] `usethis::use_github_action('check-standard')`
117+
* [ ] `usethis::use_github_action('test-coverage')`
118+
110119
<sup>Created on DATE with `usethis::use_upkeep_issue()`, using [usethis vVERSION](https://usethis.r-lib.org)</sup>
111120

0 commit comments

Comments
 (0)