Checklist of things to do before a release

Preparing a minor release 1.x.y

2 weeks before

Announce a string freeze on Trac-dev, so that the translators can catch up with the last changes.

Update the TracDev/ReleaseTesting page, ask for testers.

1 week before

Prepare the rc1 packages according to the procedure described below in Release steps, test and upload them.

Testing period. Only critical or no risk fixes.

Preparing a major release 1.x

1 month before

Announce a beta1 / string freeze on Trac-dev.

2 weeks before

Prepare the rc1 packages.

Testing period. Only critical or no risk fixes.

Release steps

Check the t.e.o wiki

• Update the ChangeLog page
• Verify TracInstall and TracUpgrade
• For major releases:
  • check TracDev/ReleaseNotes, go through the tickets which have an empty Release Notes field and say a word there
  • check TracDev/ApiChanges

Check the source

(replace trunk below with the corresponding branches/X-stable when preparing a minor releases)

Wiki related files

• Verify that TracStandalone#Reference matches current tracd --help
• If needed, do a last sync
• Check all default wikipages for TracLinks to non existing pages/resources
• Verify that trunk/trac/wiki/default-pages contains all pages listed in TracProject/DefaultWikiPages
• Update trunk/RELEASE from wiki ChangeLog
• Update trunk/ChangeLog​ from wiki ChangeLog
• Update trunk/INSTALL from wiki TracInstall
• Update trunk/UPGRADE from wiki TracUpgrade

Other repository files

• Check the trunk/THANKS​ file
• Update version number in trunk/setup.py​, trunk/trac/wiki/default-pages/WikiStart​, and trunk/trac/__init__.py​
• Check whether the jQuery and jQuery UI version numbers mentioned in the help match the actual ones (see for example r11041)
• Comment out tag_build and tag_svn_revision settings in trunk/setup.cfg​

Create dist packages

Note: be sure to use Python 2.7 on Windows

• Check out trunk (or the release branch) to a clean sandbox
• Build source tarballs:
  • On Unix:

    python setup.py sdist
    

    in order to get the files in a .tar.gz, with the proper LF line endings.
  • On Windows:

    python setup.py sdist
    

    in order to get the files in a .zip, with the proper CRLF line endings.

The sdist command must be performed from a svn < 1.7 checkout, as only the data files also listed in the .svn/entries files are considered

(that is, until ​distribute issue252 gets fixed)

• Build Windows installer
  • .exe win32 installer

    python.exe setup.py bdist_wininst
    

• Test installation on all target platforms.
  Install on a clean system. Remove any old Trac installation before testing.
• Smoke test:
  • create an environment with trac-admin, test it with tracd
  • upgrade an environment created with the previous release' trac-admin, test it with tracd

Finalize the release

• Tag/copy version in subversion
• Upload to ​http://ftp.edgewall.org/pub/trac
• Update TracDownload
• Test easy_install Trac
• Update ​PyPi entry (*)
• Post on Trac-users, Trac-dev (all releases) and Trac-announce (only for non-beta releases)
• Close release coordination ticket (e.g. #9077) (*)

(*) not for beta or rc releases

---

See also: TracDev