Release Checklist - Artheau/SpriteSomething GitHub Wiki

SpriteSomething

Releases Checklist

Update Version Number

  1. app_resources/meta/manifests/app_version.txt needs to have the major and minor version of this release. The Travis Build ID number will be appended as part of the deployment process.

Update Console usage

  1. SpriteSomething.spec includes whether or not to have the app run with a console window. If we're concerned that stuff might break and need more-in-depth debugging information, make sure console=True, else make sure console=False.

Update Documentation

  1. Each folder off of the root needs a README.md that describes what goes on in there. Not all files/directories need to be described.
  2. The root has README-files.md that describes what goes on in there. Not all files need to be described.
  3. The root has README.md that describes an overview of what SpriteSomething does and is designed to do.

Update Release Notes

  1. RELEASENOTES.md needs to detail stuff, including potentially:
    • Features included since last release
    • Features excluded since last release
    • Bugs squashed since last release
    • Bugs outstanding since last release

Deployment

  1. After preparing release on stable, push to master

    • Make sure that stable passes all of the unit tests before pushing to master!
    • Pushing to master will:
      • Produce a drafted GitHub Release
      • Push an update to the GitHub Pages server
  2. Once the GitHub Release is finished (all binaries uploaded):

    • Publish the GitHub Release
    • Click on the hyperlink to navigate to RELEASENOTES.md
    • Copy/paste the contents of RELEASENOTES.md into the body of the Release
    • Kick back a cold one