Release checklist (for maintainers)

See inst/contribute/ for helpful scripts to run, test, and debug wham locally.

In the following, I use the release of v1.0.4 as an example.

1. Confirm you are on the devel branch and it is up-to-date

git status
git pull origin devel

2. If any of the examples were modified, update

• example script code (inst/example_scripts/)
• vignette code (.Rmd files in vignettes/)
• plot files used by vignettes (vignettes/exY_plots/)
• data files used by vignettes (data/)
• test code should be consistent with example scripts (tests/testthat/)
• test results (inst/extdata/exY_test_results.rds)

3. Confirm that all tests pass

devtools::test() # if opened from wham source dir

4. Update NEWS.md. New changes should have been added here as they accumulate, but double check. Add links to issues and commits (ideally).
5. Check that new features are documented. Confirm that the documentation can be built.

devtools::document()

6. Confirm that the vignettes and website can be built, and fix any issues. Do this using RStudio because it looks nicer for some reason. To appear on the website dropdown nav bar, new vignettes and functions must be added to /wham/pkgdown/_pkgdown.yml. /wham/pkgdown/index.md is the home page on the website: https://timjmiller.github.io/wham/. /wham/README.md is the home page on Github: https://github.com/timjmiller/wham. These are basically the same except index.md allows you to embed the youtube video, which looks kind of nice. If you have added a vignette and associated files in the data folder which are sourced in the Rmd file for the vignette, you may need to install wham from your local version of the repo.

pkgdown::build_site()

7. Great, you are ready to release! Increment the version number in DESCRIPTION, e.g. Version: 1.0.3.9000 becomes Version: 1.0.4
8. Increment and date version number in NEWS.md, e.g. at the top,

wham 1.0.3.9000
=========================

becomes

wham 1.0.4 (2021-05-03)
=========================

9. Re-build the documentation and website. You should see the new release # on the main page. Do a final check.

devtools::document()
pkgdown::build_site()

10. Commit and push to github, using a message like:

git add -A
git commit -m "version 1.0.4, update docs and site"
git push origin devel

11. Checkout master, merge in the changes from devel, and push

git checkout master
git merge devel
git push origin master

12. The website should now be updated, about 30 seconds after you push to master. Check that it has all your updates: https://timjmiller.github.io/wham/.
13. Create a new release on github (Releases > Draft a new release). For the tag version and release title, put the new version number, e.g. v1.0.4. For the description, copy and paste the notes since the last release from NEWS.md. Publish!
14. Checkout devel

git checkout devel

15. Increment the version number by .9000 to indicate this is under development, it's like v1.0.4+. In DESCRIPTION, change Version: 1.0.4 to Version: 1.0.4.9000. In NEWS.md, add a new header and a couple empty lines:

wham 1.0.4.9000
=========================



wham 1.0.4 (2021-05-03)
=========================

16. Commit and push devel

git add -A
git commit -m "increment devel version"
git push origin devel