From RackTables Wiki
Revision as of 08:23, 27 March 2012 by Infrastation (talk | contribs) (pre-release checklist: let DB_VERSION alone)
Jump to: navigation, search

pre-release checklist

First make sure, that all necessary changes are already committed into the repository:

  • All release notes, if any, must appear both in upgrade script and in the README.
  • Current date must be present on the version line of ChangeLog.
  • Make sure, that upgrade.php has new version listed in $versionhistory and executeUpgradeBatch(). It is normal to accumulate updates in executeUpgradeBatch() long before the release, this way on the release day you will have nothing to do in upgrade.php. But if you had no changes to DB since the last release, you are likely to see there changes missing. Just make sure the new version is in both places anyway.
  • Bump up CODE_VERSION in inc/config.php. DON'T do this unless you really intend to make a release right now.
  • svn stat; svn commit

Now export the codebase from the trunk (or maintenance branch, whichever you are releasing from) and test it.

# export --force in case the target directory already exists
svn export .
  • The application must be able to install itself with own installer. Once this is found working, dump the database:
mysqldump --extended-insert=FALSE --order-by-primary racktables_db > ~/tmp/dump-fresh.sql
  • Demo data should also be loadable and functional:
mysql racktables_db < scripts/init-sample-racks.sql
  • The release being tested must detect and upgrade a database from the previous release(s) correctly. Load the database with one of the previous releases data, then upgrade it with the current upgrader, then dump the DB. Now compare to the previous dump, there must be no meaningful differences.
racktables/contribs/ X.Y.z racktables_db
# (upgrade.php)
mysqldump --extended-insert=FALSE --order-by-primary racktables_db > ~/tmp/dump-upgraded.sql
diff -u ~/tmp/dump-fresh.sql ~/tmp/dump-upgraded.sql
  • Test the source as much as you find possible.
  • Look into the error log of the server you used for the tests. There shouldn't be any error/warning messages.

The above rounds may happen repeated more, than once, until everything is fixed consistently.

the release itself

# from trunk (beta testing releases):
svn cp \ \

# from maintenance (stable releases):
svn cp \ \

rolling out

  • Make a tarball:
svn export
tar czf RackTables-X.Y.z.tar.gz RackTables-X.Y.z
zip -r RackTables-X.Y.z
  • Upload the tarball and zipfile to SF FRS (from browser or by other means).
  • Open files section and set the newly uploaded tar.gz as "current".
    • Open properties form (round "i" sign) of the previous release tar.gz.
    • Unset all "default download for" checkboxes.
    • Unset "download button" text.
    • Save.
    • In the latest tarball properties form, set all "default download for" checkboxes except Windows.
    • Set "download button" text to "latest stable".
    • Save.
    • In the latest zipfile properties form, set Windows "default download for" checkbox.
    • Save.
    • Hover the big green "download" button and watch the mouse hint featuring the right version number (sometimes it takes several minutes to see the update).
  • In MantisBT mark version as released (Manage, Manage Projects, RackTables, Versions).
  • Log into SF shell service:
$ cat ~/.ssh/config 
	User YOUR_SF_USERNAME,racktables
$ ssh -t create
  • Edit (vim) /home/project-web/racktables/htdocs/header.php to update $lastrelease. Test the "download" link to work after that.
  • Post a Freecode (ex-Freshmeat) release announce
    • open
    • make sure you are logged in (check top bar)
    • use "submit a release" button to the right
    • fill in version number
    • update version number in tar.gz URL field
    • compose 1-2 paragraphs worth of text describing the focus of this release
    • proofread and submit (usually it takes several hours to pass the moderation)
  • Send a letter to the racktables-users list, if necessary.
  • Update to the current release ($demorelease will need an update).
  • Update IRC channel topic