From 75ae42aed7a035d184af69129e049c31e76e5f3b Mon Sep 17 00:00:00 2001 From: dsweber2 Date: Fri, 1 Mar 2024 17:30:00 -0800 Subject: [PATCH 1/6] slightly more detailed cran comments --- cran-comments.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cran-comments.md b/cran-comments.md index a615e834..9cecaf31 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,4 +1,6 @@ +From 1.0.0 release: - Calls in the following files call an API which if queried too frequently without a key would result in CRAN being temporarily locked out of running API calls (so a soft-API key problem) - [`epidatr/R/epidatacall.R`] - [`epidatr/R/request.R`] - [`epidatr/R/endpoints.R`] + From b99ee8215481a95087fae3cc0d9fd8f049bb6172 Mon Sep 17 00:00:00 2001 From: dsweber2 Date: Mon, 4 Mar 2024 10:41:43 -0800 Subject: [PATCH 2/6] CRAN submission 1.1.1 --- CRAN-SUBMISSION | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION index 7716e2f9..51a56aa1 100644 --- a/CRAN-SUBMISSION +++ b/CRAN-SUBMISSION @@ -1,3 +1,3 @@ -Version: 1.1.0 -Date: 2024-02-27 20:25:04 UTC -SHA: 693c04bd80d3ffe0b3c012281303c4878de08c70 +Version: 1.1.1 +Date: 2024-03-02 01:36:14 UTC +SHA: 75ae42aed7a035d184af69129e049c31e76e5f3b From 1187c1f7d91beec3d991bcfea29f9ad8a5c00396 Mon Sep 17 00:00:00 2001 From: dsweber2 Date: Mon, 4 Mar 2024 13:43:34 -0800 Subject: [PATCH 3/6] updating release process --- DEVELOPMENT.md | 35 +++++++++++++++++++++++++++++------ 1 file changed, 29 insertions(+), 6 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 63e3340f..4fc4c7ab 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -56,9 +56,32 @@ If you want to extend it, add to the `release_bullets` function in [utils.R](htt devtools::check(".", manual = TRUE, env_vars =c(NOT_CRAN = "false")) ``` -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. - -When this has gone smoothly enough, release to CRAN via -```R -devtools::release(check = TRUE) -``` +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: +Prepare for release: + +* [ ] `git pull` +* [ ] Check [current CRAN check results](https://cran.rstudio.org/web/checks/check_results_epidatr.html) +* [ ] `devtools::check(remote = TRUE, manual = TRUE)` +* [ ] if check works well enough, merge to main. Otherwise open a PR to fix up. +* [ ] [Polish NEWS](https://github.com/cmu-delphi/epidatr/blob/dev/NEWS.md): some [Guidelines](https://style.tidyverse.org/news.html#news-release) +* [ ] `git checkout main` +* [ ] `git pull` +* [ ] `urlchecker::url_check()`. This may choke on the MIT license url, and that's ok. +* [ ] `devtools::build_readme()` +* [ ] `devtools::check_win_devel()` +* [ ] check email for problems +* [ ] `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. +* [ ] Update `cran-comments.md` +* [ ] PR with any changes + +Submit to CRAN: + +* [ ] `devtools::submit_cran()` +* [ ] Approve email + +Wait for CRAN... + +* [ ] Accepted :tada: +* [ ] `dev` +* [ ] `usethis::use_github_release(publish = FALSE)` (publish off, otherwise it won't push). +* [ ] check the release notes and publish the branch on github From b3c13fab1ebd4af824c824e1b1e54949cdf7d858 Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 4 Mar 2024 15:00:40 -0800 Subject: [PATCH 4/6] repo: we don't use bump2version any more --- .bumpversion.cfg | 8 -------- 1 file changed, 8 deletions(-) delete mode 100644 .bumpversion.cfg diff --git a/.bumpversion.cfg b/.bumpversion.cfg deleted file mode 100644 index f6301400..00000000 --- a/.bumpversion.cfg +++ /dev/null @@ -1,8 +0,0 @@ -[bumpversion] -current_version = 1.0.0.9000 -commit = False -tag = False - -[bumpversion:file:DESCRIPTION] - -[bumpversion:file:R/constants.R] From 07f26a789061decf8ef5de0a7f71baf92c18285d Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 4 Mar 2024 15:00:59 -0800 Subject: [PATCH 5/6] doc: update release process instructions with checklist --- DEVELOPMENT.md | 61 ++++++++++++++++++++++---------------------------- 1 file changed, 27 insertions(+), 34 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 4fc4c7ab..cd7d75a3 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -1,7 +1,7 @@ ## Setting up the development environment ```r -install.packages(c('devtools', 'pkgdown', 'styler', 'lintr')) # install dev dependencies +pak::pkg_install(c('devtools', 'pkgdown', 'styler', 'lintr')) # install dev dependencies devtools::install_deps(dependencies = TRUE) # install package dependencies devtools::document() # generate package meta data and man files devtools::build() # build package @@ -45,43 +45,36 @@ python -m http.server -d docs Please follow the guidelines in the [PR template document](.github/pull_request_template.md). ## Release process -First, there's a handy function that makes a github issue; for example, at the time of writing we were doing: -```R -usethis::use_release_issue(version = "1.0.2") -``` -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). - First, make sure that all the checks pass - -```R -devtools::check(".", manual = TRUE, env_vars =c(NOT_CRAN = "false")) -``` -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: -Prepare for release: - -* [ ] `git pull` -* [ ] Check [current CRAN check results](https://cran.rstudio.org/web/checks/check_results_epidatr.html) -* [ ] `devtools::check(remote = TRUE, manual = TRUE)` -* [ ] if check works well enough, merge to main. Otherwise open a PR to fix up. -* [ ] [Polish NEWS](https://github.com/cmu-delphi/epidatr/blob/dev/NEWS.md): some [Guidelines](https://style.tidyverse.org/news.html#news-release) -* [ ] `git checkout main` -* [ ] `git pull` -* [ ] `urlchecker::url_check()`. This may choke on the MIT license url, and that's ok. -* [ ] `devtools::build_readme()` -* [ ] `devtools::check_win_devel()` -* [ ] check email for problems -* [ ] `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. -* [ ] Update `cran-comments.md` -* [ ] PR with any changes +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")`): + +- [ ] `git pull` +- [ ] Check [current CRAN check results](https://cran.rstudio.org/web/checks/check_results_epidatr.html) +- [ ] `devtools::check(".", manual = TRUE, env_vars = c(NOT_CRAN = "false"))`. + - Aim for 10/10, no notes. +- [ ] If check works well enough, merge to main. Otherwise open a PR to fix up. +- [ ] [Polish NEWS](https://github.com/cmu-delphi/epidatr/blob/dev/NEWS.md). + - Some [guidelines](https://style.tidyverse.org/news.html#news-release). +- [ ] `git checkout main` +- [ ] `git pull` +- [ ] `urlchecker::url_check()`. + - This may choke on the MIT license url, and that's ok. +- [ ] `devtools::build_readme()` +- [ ] `devtools::check_win_devel()` +- [ ] Check email for problems +- [ ] `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. +- [ ] Update `cran-comments.md` +- [ ] PR with any changes Submit to CRAN: -* [ ] `devtools::submit_cran()` -* [ ] Approve email +- [ ] `devtools::submit_cran()` +- [ ] Approve email Wait for CRAN... -* [ ] Accepted :tada: -* [ ] `dev` -* [ ] `usethis::use_github_release(publish = FALSE)` (publish off, otherwise it won't push). -* [ ] check the release notes and publish the branch on github +- [ ] Accepted :tada: +- [ ] `dev` +- [ ] `usethis::use_github_release(publish = FALSE)` (publish off, otherwise it won't push). +- [ ] check the release notes and publish the branch on github From 8405a20d790ce89d7791b6235684a7ec7e971ad1 Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 4 Mar 2024 15:01:07 -0800 Subject: [PATCH 6/6] doc: add CRAN link to readme --- README.Rmd | 2 ++ README.md | 3 +++ 2 files changed, 5 insertions(+) diff --git a/README.Rmd b/README.Rmd index 51f3670c..744b4dfb 100644 --- a/README.Rmd +++ b/README.Rmd @@ -79,6 +79,8 @@ pak::pkg_install("epidatr") pak::pkg_install("cmu-delphi/epidatr@dev") ``` +Our CRAN listing is [here](https://cran.r-project.org/web/packages/epidatr/index.html). + ### API Keys The Delphi API requires a (free) API key for full functionality. To generate diff --git a/README.md b/README.md index e849ac2d..e7598e4b 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,9 @@ pak::pkg_install("epidatr") pak::pkg_install("cmu-delphi/epidatr@dev") ``` +Our CRAN listing is +[here](https://cran.r-project.org/web/packages/epidatr/index.html). + ### API Keys The Delphi API requires a (free) API key for full functionality. To