Feature Request: Developer Function - `release_issue()`

[bms63]

Feature Idea

The usethis package has a relase_issue() function that produces an issue on the GitHub Repo with the following:

Original Checklist

Prepare for release:

• [ ] git pull
• [ ] Check current CRAN check results
• [ ] Check if any deprecation processes should be advanced, as described in Gradual deprecation
• [ ] Polish NEWS
• [ ] urlchecker::url_check()
• [ ] devtools::check(remote = TRUE, manual = TRUE)
• [ ] devtools::check_win_devel() - doesn't work with Remtoes
• [ ] rhub::check_for_cran()
• [ ] revdepcheck::revdep_check(num_workers = 4)
• [ ] Update cran-comments.md
• [ ] git push
• [ ] Draft blog post

Submit to CRAN:

• [ ] usethis::use_version('major')
• [ ] devtools::submit_cran()
• [ ] Approve email

Wait for CRAN...

• [ ] Accepted :tada:
• [ ] git push
• [ ] usethis::use_github_release()
• [ ] usethis::use_dev_version()
• [ ] git push
• [ ] Finish blog post
• [ ] Tweet
• [ ] Add link to blog post in pkgdown news menu

Some of these items in the checklist are not really helpful to us. However, we can customize this function to produce a scoped release issue for admiral.

Proposed New Checklist (TBD!!)

Prepare for release:

• [ ] Check current CRAN check results
• [ ] Check if any deprecation processes should be advanced, as described in Gradual deprecation
• [ ] Polish NEWS
• [ ] urlchecker::url_check()
• [ ] devtools::check(remote = TRUE, manual = TRUE)
• [ ] devtools::check_win_devel() - doesn't work with Remtoes
• [ ] rhub::check_for_cran()
• [ ] revdepcheck::revdep_check(num_workers = 4)
• [ ] Draft blog post
• [ ] Establish timelines with Roche for their checks
• [ ] Review admiraldev DESCRIPTION file, issues, etc
• [ ] Quick Review of dev version of website
• [ ] Check in with other admiral extension package maintainers (optha, onco, vaccines, discovery, sdtm, adam)

Submit to CRAN:

• [ ] usethis::use_version('major')
• [ ] Remove Remotes from DESCRIPTION
• [ ] devtools::submit_cran()
• [ ] Approve email

Wait for CRAN...

• [ ] usethis::use_github_release()
• [ ] usethis::use_dev_version()
• [ ] Finish blog post
• [ ] Post on Slack and LinkedIn
• [ ] Add link to blog post in pkgdown news menu

Definition of Done

• [ ] A function called release_issue() is created
• [ ] function is not exported
• [ ] Produces the above checklist our admiral github repo

[bms63]

@pharmaverse/admiral Hi all - Thinking that this will be a very useful part of our release process. I used the vanilla version of the usethis::release_issue() and it made the issue on our GitHub Issues. However, I didn't find all the items very helpful.

Part of me is thinking - should it be broken into 3 issues? Pre-CRAN, Submit to CRAN, Post-CRAN. So the function would make three issues for us. I like smaller issues that we can close quickly. If we keep it as one issue, then it stays around until we finish every item :(

The checklist is not final. There are other things that are needed - just can't think of them at the moment. Post here if there is some missing checks that we should add!

[bms63]

Since admiraldev is no longer going to be purged...I think we should put this there.