5.0.0 Release Checklist

[aaronayres35]

Target date:

Release Candidate by YYYY-MM-DD

Release by YYYY-MM-DD

Release candidate

• Verify that all relevant PRs have been merged to master.
• Create a PR against master to bump version number, merge that PR (Bump version for continued development (5.1.x) #254)
• From the commit just before bumping the version, create a new branch maint/<release version number>
• Update changelog and open PR targeting a new maint/<release version number> branch.
  To do so, use the python etstool.py changelog build command to update the changelog
  file. You will still need to review / edit it and also confirm that all news fragments
  were included / delete the files. (Update changelog for 5.0.0 release and remove news fragment files #255)
• Update ci-src-requirements.txt if needed
• Check MANIFEST and requirements are still up to date. (remove TODO.txt from manifest.in as the file was deleted #256)
• Update version in setup.py for the prerelease, open 2 PRs against maint/<release version number>
  • Create a new branch from maint/<release version number>: git checkout maint/<release version number>; 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 <release version number>rc1"
  • Open and merge a PR against maint/<release version number> (Release Candidate 5.0.0rc1 #258)
  • Create a new branch from maint/<release version number>, Flip IS_RELEASED back to false, commit.
  • Open and merge another PR against maint/<release version number> (Set IS_RELEASED back to False #259)
• Tag (annotated!) the release candidate on the commit where IS_RELEASED is set to true, e.g. git tag -a -m "Release candidate <release version number>rc1" <release version number>rc1 <commit-hash>
• Push the tag to GitHub
• Upload to PyPI
  - git checkout <tag>, 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) (Backports for 5.0.0 and update Changelog #263)
• Verify that no other open issue needs to be addressed before the release.
• Test against other ETS packages and other ETS-using projects (ran envisage and mayavi test suites)
• Check MANIFEST, requirements, changelog are still up to date. (Backports for 5.0.0 and update Changelog #263 )
• Test building the documentation

Release

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

Post-release

• Package update for enthought/free repository (for EDM)
• Backport change log (and any deletion of news fragments) to master (Update changelog master after release of 5.0.0 #267)
• Update GitHub Release pages https://github.com/enthought/apptools/releases
• Announcement (e.g. Google Group)

[aaronayres35]

We would like to address the following issues before the release:

• Make sure that optional dependencies are also optional for tests #99
• Add extra_requires in setup.py for optional dependencies #176
• image_LICENSE.txt needs updating #236

[aaronayres35]

I tested building the documentation and there are not warnings/errors and everything looks good.
However, we still have the "Undo Framework" section of the documentation and it does not currently mention the deprecation.
I'm not sure if this is a release blocker, but it is something we will probably want to update at some point

[rahulporuri]

it'll be good to mention in the release announcement that devs might find it useful to enable warnings by default when running the testsuite.

[aaronayres35]

closing as I have just made the announcement