Skip to content

Commit 07f26a7

Browse files
committed
doc: update release process instructions with checklist
1 parent b3c13fa commit 07f26a7

File tree

1 file changed

+27
-34
lines changed

1 file changed

+27
-34
lines changed

DEVELOPMENT.md

Lines changed: 27 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Setting up the development environment
22

33
```r
4-
install.packages(c('devtools', 'pkgdown', 'styler', 'lintr')) # install dev dependencies
4+
pak::pkg_install(c('devtools', 'pkgdown', 'styler', 'lintr')) # install dev dependencies
55
devtools::install_deps(dependencies = TRUE) # install package dependencies
66
devtools::document() # generate package meta data and man files
77
devtools::build() # build package
@@ -45,43 +45,36 @@ python -m http.server -d docs
4545
Please follow the guidelines in the [PR template document](.github/pull_request_template.md).
4646

4747
## Release process
48-
First, there's a handy function that makes a github issue; for example, at the time of writing we were doing:
49-
```R
50-
usethis::use_release_issue(version = "1.0.2")
51-
```
52-
If you want to extend it, add to the `release_bullets` function in [utils.R](https://github.com/cmu-delphi/epidatr/blob/dev/R/utils.R).
53-
First, make sure that all the checks pass
54-
55-
```R
56-
devtools::check(".", manual = TRUE, env_vars =c(NOT_CRAN = "false"))
57-
```
5848

59-
Aim for 10/10, no notes. Generally, follow the issue. `revdep_check` is likely to fail but doesn't seem to be terribly important. So for now ignore it. Actually, the issue is off a bit: use the following instead:
60-
Prepare for release:
61-
62-
* [ ] `git pull`
63-
* [ ] Check [current CRAN check results](https://cran.rstudio.org/web/checks/check_results_epidatr.html)
64-
* [ ] `devtools::check(remote = TRUE, manual = TRUE)`
65-
* [ ] if check works well enough, merge to main. Otherwise open a PR to fix up.
66-
* [ ] [Polish NEWS](https://github.com/cmu-delphi/epidatr/blob/dev/NEWS.md): some [Guidelines](https://style.tidyverse.org/news.html#news-release)
67-
* [ ] `git checkout main`
68-
* [ ] `git pull`
69-
* [ ] `urlchecker::url_check()`. This may choke on the MIT license url, and that's ok.
70-
* [ ] `devtools::build_readme()`
71-
* [ ] `devtools::check_win_devel()`
72-
* [ ] check email for problems
73-
* [ ] `revdepcheck::revdep_check(num_workers = 4)`. This may choke, it is very sensitive to the binary versions of packages on a given system. Either bypass or ask someone else to run it if you're concerned.
74-
* [ ] Update `cran-comments.md`
75-
* [ ] PR with any changes
49+
Open a release issue and then copy and follow this checklist in the issue (modified from the checklist generated by `usethis::use_release_issue(version = "1.0.2")`):
50+
51+
- [ ] `git pull`
52+
- [ ] Check [current CRAN check results](https://cran.rstudio.org/web/checks/check_results_epidatr.html)
53+
- [ ] `devtools::check(".", manual = TRUE, env_vars = c(NOT_CRAN = "false"))`.
54+
- Aim for 10/10, no notes.
55+
- [ ] If check works well enough, merge to main. Otherwise open a PR to fix up.
56+
- [ ] [Polish NEWS](https://github.com/cmu-delphi/epidatr/blob/dev/NEWS.md).
57+
- Some [guidelines](https://style.tidyverse.org/news.html#news-release).
58+
- [ ] `git checkout main`
59+
- [ ] `git pull`
60+
- [ ] `urlchecker::url_check()`.
61+
- This may choke on the MIT license url, and that's ok.
62+
- [ ] `devtools::build_readme()`
63+
- [ ] `devtools::check_win_devel()`
64+
- [ ] Check email for problems
65+
- [ ] `revdepcheck::revdep_check(num_workers = 4)`.
66+
- This may choke, it is very sensitive to the binary versions of packages on a given system. Either bypass or ask someone else to run it if you're concerned.
67+
- [ ] Update `cran-comments.md`
68+
- [ ] PR with any changes
7669

7770
Submit to CRAN:
7871

79-
* [ ] `devtools::submit_cran()`
80-
* [ ] Approve email
72+
- [ ] `devtools::submit_cran()`
73+
- [ ] Approve email
8174

8275
Wait for CRAN...
8376

84-
* [ ] Accepted :tada:
85-
* [ ] `dev`
86-
* [ ] `usethis::use_github_release(publish = FALSE)` (publish off, otherwise it won't push).
87-
* [ ] check the release notes and publish the branch on github
77+
- [ ] Accepted :tada:
78+
- [ ] `dev`
79+
- [ ] `usethis::use_github_release(publish = FALSE)` (publish off, otherwise it won't push).
80+
- [ ] check the release notes and publish the branch on github

0 commit comments

Comments
 (0)