About releasing new versions

(added "Where to advertise a new release")
(Checklist for stable releases)
Line 38: Line 38:
** Make sure data/CREDITS is still in UTF (not ascii).
** Make sure data/CREDITS is still in UTF (not ascii).
* Test to run when no sound card is available. Sound should be disabled and continue, not crash.
* Test to run when no sound card is available. Sound should be disabled and continue, not crash.
 +
* Check that the addon server has all achievements defined (data/achievements.xml should be in sync with table v2_achievements).
Upload packages, then :
Upload packages, then :

Revision as of 04:36, 20 January 2015

Contents

Unstable releases vs stable releases

Any packages released from the trunk are considered 'unstable'. They are not meant to be broken, but fewer steps are taken to produce it, skipping the ones that often catch bugs, which also makes them easier and faster to make, so they are better suited to make it easier to test new features quickly. The process is simply to make a package for general distribution from source of the trunk.

To make a stable package, first a separate branch must be created in the source tree, by copying the current trunk to a branch, as a 'release candidate'(RC), named with the version number plus the RC number, for example, 0.3rc1. Afterwards, only bug fixes are committed to that branch (unless we all agree to introduce a feature) on this release candidate; neither major changes in other areas of the game, thought documentation and artwork updates are fine. If we decide we need more testing after doing all the modifications to the release candidate, the same RC should be renamed to reflect the new number scheme (e.g. 0.3rc1 would be renamed to 0.3rc2). This allows easy access to the history of all files, and keeps the SVN structure clean (it might be worth adding a tag for previous RCs).

The final release is copied from the RC branch to the tag directory (using the release number as name). The branch will be removed to reflect the release number (e.g. 0.3rc2 -> 0.3). For now the branches should be kept in place, since it helps finding problems which might get reported for the release (if they can't be reproduced in the trunk anymore). We might decide on a delete-branch policy later, if this directory gets too full. Also, the license under which STK is released requires us to provide the source code for at least 3 years for any binaries we provide.

Committing changes during the preparation of a stable release

Checklist for stable releases

Upload packages, then :

For binary packages (esp. linux):

Naming scheme for packages

All files released on the STK web page should use the following naming scheme:

supertuxkart-<VERSION>-<ARCHITECTURE>.<FILE EXTENSION>

VERSION:

ARCHITECTURE:

FILE EXTENSION:


Examples of full package file names: supertuxkart-0.3-linuxi586.tar.bz2, supertuxkart-SVN2110-macosx.dmg, supertuxkart-0.4rc1-win.zip

Where to advertise a new release

This page collects web pages that should be informed about a new SuperTuxKart release. If you add a note to a board, blog, web page, please add the URL here, and add your name (hoping that in upcoming releases you can contact the same pages again).

Mark what's done with Done.png


Retrieved from "http://supertuxkart.sourceforge.net/About_releasing_new_versions"

User Tools