5.1.0 Release Checklist

[rahulporuri]

Target date: 15 Jan 2021

Release Candidate by YYYY-MM-DD This is a minor version release which does not introduce a lot of changes so the plan is to not make a release candidate.

Release by 15 Jan 2021

Release blockers

• There are no release blockers
• There are no issues that need to be resolved before the release
• There are no open PRs that need to be merged before the release

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.1.0 #279)
• 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. (update changelog for 5.1.0 release and remove news fragment files #277)
• 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.1.0 #280)
  • 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.1.1 #281)
• 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.1.0 #282)
• 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.1.0 #283)
• Update GitHub Release pages https://github.com/enthought/apptools/releases
• Announcement (e.g. Google Group)

[aaronayres35]

One thing to note in regards to the news fragments process:
A mistake was made in #267. Notice that in #255 which was merged into maint/5.0 the news fragment files were deleted when we updated the changelog as they should be. However, when pulling these changes to master, the news fragments somehow went undeleted. See: https://github.com/enthought/apptools/tree/master/docs/releases/upcoming

It seems the problem is that #267 cherrypicked from #263 which made changes on top of what was made in #255 by backporting changes from master into maint/5.0 and updating the changelog on top of what was already done by #255. The problem is the deletions of the news fragments were not picked up.

This is no big deal, I can manually delete them to update the changelog for 5.1 but moving forward with future releases this is something we will want to pay attention to

[aaronayres35]

Closing as I have just made the announcement