Repository navigation
ReleaseProcess
Each release has a version number, of the form X.Y.Z. As at writing, the most recent release was 0.2.1. Y is incremented when we have added lots of features and want to release a new milestone.
Z is incremented when we're fixing bugs and releasing moderately soon after the previous X.Y release (it can also contain new features). But Z does not get incremented in response to fixes as part of the release process.
X will be incremented to 1 if and when we reach feature completeness.
These need to be built for:
- Windows - NSIS installer.
- OSX - installer.
- Linux - 32- and 64-bit .deb files for Ubuntu/Mint.
TODO Fill in details for each platform
The content files for each release are:
- P6014-X.Y.Z-prv-content.uqm
- P6014-X.Y.Z-prv-voice.uqm
- P6014-X.Y.Z-prv-3domusic.uqm
- P6014-X.Y.Z-prv-hires2x.uqm
- P6014-X.Y.Z-prv-hires4x.uqm
For Linux these are also packaged as .deb files.
The last two benefit from compression by the compress_uqm.py tool. Steps for this:
- Make a copy of the content directory to compress, e.g. copy addons/hires4x to tmp/hires4x.
- Run
compress_uqm tmp/hires4x --apply. This will compress that directory in place. - Package the directory normally into a UQM file.
- Quickly test that the UQM file works by running the game with it. It should be obvious if there are problems just starting a new game.
(See issue 57 for additional comments).
Once the packages (installers and content) are built, tested, and finalised, the source should be tagged. Use a command like the following:
svn copy -r REV https://github.com/jorisvddonk/project6014 https://github.com/jorisvddonk/project6014/releases -m 'Make tag for release X.Y.Z.'
Where REV is the revision (as near as can be determined) that was packaged. Use the list of changes to double check. X.Y.Z is the version number as explained above.
Upload to Google Code and Joris's mirror.
N.B. Google Code has a size limit of 200MB. This means the hires4x file in particular may need to be split when hosted on that location.
Update the Downloads wiki page.
This should be done with some coordination. If possible,
- Do it when the above steps are mostly finalised.
- Agree on the text of the announcements with the team.
The announcement text can be different for each location. It should contain a link to the Downloads page, and a short list of new features. Depending on the location (e.g. in general discussion forums) it may contain some project background.
Announcements should be made in these places at the very least:
- Update the Home page (using the Administer tab)
- Start announcement topics on the two forums: * UQM Forums -- example. * Pages of Now and Forever -- example.
- Post a message to the project6014-users mailing list.
We can also make announcements at places like Reddit's r/games for further publicity. Here's an example.
Wiki Contents
- Game information
- Development
- DesignNotes
- Story Wiki
- Implementation details
- Older material
- Administration
- Project Rules
- Want to help? HelpingOutIntroduction
- SVN Contributing
- Release Process
- Porting Changes
- Statistics
- Developer Forum
- Team
- TheMisterCat
- add others here!