Release checklist

From Bitfighter
Revision as of 22:36, 6 January 2015 by Watusimoto (Talk | contribs)

  1. Make sure all code is checked in to HG
    • Disable any experimental features in development
  2. Update checkIfThisIsAnUpdate() in main.cpp and add any update tasks
  3. Make sure dedicated server compiles
  4. 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.
  5. Re-checkin to HG, so version numbers are correct, and everything aligns correctly NOTE THAT THE TAG WILL COUNT AS A VERSION!
  6. Tag the release in HG. Use format "bitfighter-019d"
  7. Build for Windows (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
  8. Build for OSX (ppc, i386, x86_64)
    • Each architecture is a different DMG
    • Test DMGs
  9. Build for Linux
  10. Upload all builds to bitfighter.org/files/
    • Test downloads
  11. Put copy of source tarball at static URL to help maintainers:
  12. Rebuild any servers that need rebuilding
  13. 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 the old build version
  14. 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)
  15. 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
  16. Post announcement in forums
  17. Announce new version via email
  18. Post the update to gaming web sites
  19. Update /topic on #bitfighter IRC channel
  20. Update the Building Bitfighter page