Release process

This page documents the steps to follow to make a new release of QMCPACK. The examples are given for the 3.1.0 release.

1. Make a fresh clone of the repo and create a release candidate branch labeled rc_Mmp where Mmp are digits following semantic versioning.

git clone https://github.com/QMCPACK/qmcpack.git
cd qmcpack
git branch rc_310
git checkout rc_310

2. Update the QMCPACK_VERSION_MAJOR, QMCPACK_VERSION_MINOR, QMCPACK_VERSION_PATCH version numbers in qmcpack/CMakeLists.txt
3. Update qmcpack/CHANGELOG.MD by replacing the unreleased section with the new version and release date. Update the notes section to recommend the update to all users (if appropriate) and note any major headline items such as backwards incompatibility.

git add qmcpack/CMakeLists.txt qmcpack/CHANGELOG.MD
git commit -m "Increase version number, update release notes"
git push origin rc_310

4. On GitHub, make a pull request into the master branch from the rc.
5. Ensure CI tests run and pass.
6. Make an independent download of the proposed merged PR.
7. Verify code configures and builds on at least one system.
8. Run non-long tests, confirm version reports correctly. e.g. ctest -VV -E long
9. Push any needed fixes to the rc and repeat the tests.
10. Add notes on the test status to the PR.
11. Request reviewer / other PR approver approves the merge. At least one review is required to merge to master.
12. Merge the PR.
13. Create a new release using the release tool on GitHub. Link to the CHANGELOG in the release notes. The GitHub link can be copied & updated from previous release.
14. Issue a PR back to develop from master to update with the new version number and any other updates made to the rc.
15. Delete the rc branch.
16. Announce the release on google groups and QMCPACK.org.