Difference between revisions of "Release checklist"
              From Bitfighter            
            | Line 12: | Line 12: | ||
# Re-checkin to HG, so version numbers are correct, and everything aligns correctly NOTE THAT THE TAG WILL COUNT AS A VERSION!  | # Re-checkin to HG, so version numbers are correct, and everything aligns correctly NOTE THAT THE TAG WILL COUNT AS A VERSION!  | ||
# Tag the release in HG.  Use format "bitfighter-019d"  | # Tag the release in HG.  Use format "bitfighter-019d"  | ||
| − | # Build for Windows (32-bit is NSI, 64-bit is MSI):  | + | # Build for Windows:  | 
| − | #* Compile the game as a '''Release''' version  | + | #* Installers (32-bit is NSI, 64-bit is MSI):  | 
| − | #* Compile 'bfup'  | + | #** Compile the game as a '''Release''' version  | 
| − | #* Build notifier; use script in notifier/pyinstaller/  | + | #** Compile 'bfup'  | 
| − | #* Build package using the PACKAGE target in Visual Studio  | + | #** Build notifier; use script in notifier/pyinstaller/  | 
| − | #* Test the installers  | + | #** Build package using the PACKAGE target in Visual Studio  | 
| − | #*  | + | #** Test the installers:  | 
| + | #*** Brand new install with no preference folder created  | ||
| + | #*** Old preference updating in %appdata%/Bitfighter  | ||
| + | #* Portable build:  | ||
| + | #** Copy installed 'Bitfighter' folder from Win32 installer (found in Program Files) to some other place to create the portable build  | ||
| + | #** Remove 'Uninstall.exe'.  Add 'standalone.txt'  | ||
| + | #** Remove any bitfighter.ini or log files found  | ||
| + | #** Zip up folder and name zip like 'Bitfighter-019e-win32-portable.zip'  | ||
# Build for OSX (ppc, i386, x86_64)  | # Build for OSX (ppc, i386, x86_64)  | ||
#* Each architecture is a different DMG  | #* Each architecture is a different DMG  | ||
Revision as of 03:35, 30 April 2017
-  Make sure all code is checked into version control and pushed to github
- Disable any experimental features in development
 
 - Update checkIfThisIsAnUpdate() in main.cpp and add any update tasks
 - Update joystick definition file from https://github.com/gabomdq/SDL_GameControllerDB/blob/master/gamecontrollerdb.txt
 - Make sure dedicated server compiles
 -  Update version.h:
- Change ZAP_GAME_RELEASE to new version
 - Change BUILD_VERSION to (current commit number + 1) (found by running 'hg summary')
 - If new client-server is incompatible with the old, update CS_PROTOCOL_VERSION
 - If new client-master is incompatible with the old, update MASTER_PROTOCOL_VERSION
 - Important: Make sure version.h parsing works in CMake. It will output to the console when it is run.
 
 - Re-checkin to HG, so version numbers are correct, and everything aligns correctly NOTE THAT THE TAG WILL COUNT AS A VERSION!
 - Tag the release in HG. Use format "bitfighter-019d"
 -  Build for Windows:
-  Installers (32-bit is NSI, 64-bit is MSI):
- Compile the game as a Release version
 - Compile 'bfup'
 - Build notifier; use script in notifier/pyinstaller/
 - Build package using the PACKAGE target in Visual Studio
 -  Test the installers:
- Brand new install with no preference folder created
 - Old preference updating in %appdata%/Bitfighter
 
 
 -  Portable build:
- Copy installed 'Bitfighter' folder from Win32 installer (found in Program Files) to some other place to create the portable build
 - Remove 'Uninstall.exe'. Add 'standalone.txt'
 - Remove any bitfighter.ini or log files found
 - Zip up folder and name zip like 'Bitfighter-019e-win32-portable.zip'
 
 
 -  Installers (32-bit is NSI, 64-bit is MSI):
 -  Build for OSX (ppc, i386, x86_64)
- Each architecture is a different DMG
 - Test DMGs
 
 -  Build for Linux
- Create source package for Linux distros. Use the 'create_tarball.sh' script from the bitfighter tools repo. Note the excludes list inside the script which strips out non-Linuxy stuff
 - Standalone build
 -  Various Linux distros:
- Use Open Build Service (or tell other distros about the new release.) Link: https://build.opensuse.org/package/show?package=bitfighter&project=games
 - Flag old package as being out of date on Arch: https://aur.archlinux.org/packages/bitfighter/ (login, click "Flag as out of date" link on right)
 
 
 - Update Desura page
 -  Upload all builds to bitfighter.org/files/
- Test downloads
 
 -  Put copy of source tarball at static URL to help maintainers:
-  On bitfighter.org:
- sudo ln -s /var/www/html/files/bitfighter-019e.tar.gz /var/www/html/files/bitfighter-latest.tar.gz
 
 - File will be available from http://bitfighter.org/files/bitfighter-latest.tar.gz
 
 -  On bitfighter.org:
 - Rebuild any servers that need rebuilding
 -  Update master.ini:
-  [host] section:
- Update latest_released_client_build_version
 - Update latest_released_cs_protocol (if needed)
 
 -  [motd_clients] section:
- Add a new line for a message for a particular release (like if a bad client was released)
 
 
 -  [host] section:
 -  Update auto-update file (/var/www/html/files/getDownloadUrl.php) on master server
- Sign the Mac files with our private key for the Sparkle updates
 - Update versions/dates in the php file (add sparkle signatures)
 
 -  Update bitfighter website
- Add new release to all releases page
 - Update download page to show new release
 - Add story to main page on website announcing new release
 - Update luadoc/doxygen
 
 - Post announcement in forums
 - Announce new version via email
 -  Post the update to gaming web sites
-  
http://freecode.com/projects/bitfighter/releases(site appears defunct) - http://www.lgdb.org/node/1076/edit
 - linuxgames.com (No BF news has been published since 017, try including a screen shot)
 - GameJolt
 -  itch.io
- Add news item
 - Update all downloads (will need to download all copies of installer from bf.org to local machine first)
 
 
 -  
 - Update /topic on #bitfighter IRC channel
 - Update the Building Bitfighter page
 
Update screenshots here: http://www.lgdb.org/node/1076/edit Desura GameJolt itch.io
