[5.0.0] Release Checklist

Target date: Undecided

Release Candidate by Undecided

Release by Undecided

Release candidate
-------------------
- [ ] Verify that all relevant PRs have been merged to master.
- [ ] Create a PR against master to bump version number, merge that PR
- [ ] From the commit just before bumping the version, create a new branch `maint/`
- [ ] Update changelog and open PR targeting a new `maint/` branch
- [ ] Update `ci-src-requirements.txt` if needed
- [ ] Check MANIFEST and requirements are still up to date.
- [ ] Update version in setup.py for the prerelease, open 2 PRs against `maint/`
- [ ] Create a new branch from `maint/`: `git checkout maint/`; `git pull`; `git checkout -b call-it-anything-you-like`
- [ ] Set `PRERELEASE` to "rc1" and `IS_RELEASED` to true, commit, e.g. `git commit -m "Set IS_RELEASED to true for prerelease rc1"`
- [ ] Open and merge a PR against `maint/`
- [ ] Create a new branch from `maint/`, Flip `IS_RELEASED` back to false, commit.
- [ ] Open and merge another PR against `maint/`
- [ ] Tag (annotated!) the release candidate on the commit where IS_RELEASED is set to true, e.g. `git tag -a -m "Release candidate rc1" rc1 `
- [ ] Push the tag to GitHub
- [ ] Upload to PyPI
- `git checkout `, `git clean -ffxd`, `python setup.py sdist`, `twine check dist/<...>.tar.gz`, `twine upload dist/<...>.tar.gz`
- [ ] Announcement for the release candidate

Release blockers
----------------
- [ ] (add blocking issues/PRs here)

Pre-release
---
- [ ] Backport PRs that have been merged to master to the maintenance branch. Use the "need backport ..." tag if there is one (but don't rely 100% on it)
- [ ] Verify that no other open issue needs to be addressed before the release.
- [ ] Test against other ETS packages and other ETS-using projects
- [ ] Check MANIFEST, requirements, changelog are still up to date.
- [ ] Test building the documentation

Release
-------
- [ ] Create branch `release/` from `maint/` branch.
- [ ] Set release to ``, and set `IS_RELEASED` is true; commit
- [ ] Install from source distribution and run tests again
- [ ] Open a PR against `maint/` with this being the last commit so that CI is built on the release commit
- [ ] Once CI is done building merge PR
- [ ] Bump the micro version number i.e. `` and set `IS_RELEASED` to false; commit.
- [ ] Open and then merge a separate PR against `maint/`
- [ ] From the commit at which `IS_RELEASED` is true and version is ``, tag (annotated!) `git tag -a -m "Release " `
- [ ] Push the tag `git push origin `
- [ ] Make PR targeting `gh-pages` branch: Generate documentation and copy the content to the branch. Verify that the resulting index.html looks good.
- [ ] Upload to PyPI
- [ ] Test the PyPI package

Post-release
-------------
- [ ] Package update for `enthought/free` repository (for EDM)
- [ ] Backport release note and change log to master, and possibly `maint/` branch.
- [ ] Update GitHub Release pages https://github.com/enthought/scimath/releases
- [ ] Announcement (e.g. Google Group)

Note that this checklist is what we use for PyFace releases - https://github.com/enthought/pyface/tree/166156a14ad8db0f1f22b069c2020ef6f6e0ca85/.github/ISSUE_TEMPLATE