Skip to content

Release Procedure Notes and Checklist

shurne edited this page Jun 29, 2016 · 4 revisions

Release Procedure Checklist

The following checklist consists of my basic notes with procedures and reminders of steps and actions to take when generating a new release of the GW2 Personal Assistant Overlay. This checklist is meant to serve as a guide and reminder of what's involved to generate a release of the overlay.
TODO: This is way too involved of a release process... automate this/make it simpler to make a release build.

  • Ensure all changes are committed
  • Update Item Names database for each language, commit to source control
  • Update assembly versions, commit to source control
  • Verify crash report e-mail credentials are added to source code (Do not commit to source control)
  • Clean all build output directories
  • Clean/Build Release build configuration
  • Clean/Build Release_WithoutBrowser build configuration
  • Update setup.iss installer build script, commit to source control
  • Place pre-generated player tasks files within "Tasks" directory in Release build output directory
  • Place pre-generated player tasks files within "Tasks" directory in Release_WithoutBrowser build output directory
  • Compile setup.iss installer build script to generate installer for release
  • Generate .zip file of Release build output (GW2PAO_[version].zip)
  • Generate .zip file of Release_WithoutBrowser build output (GW2PAO_[version]_NoBrowser.zip)
  • Perform Smoke Test of Installer (with browser option)
  • Perform Smoke Test of Installer (without browser option)
  • Perform Smoke Test of Release build .zip
  • Perform Smoke Test of Release_NoBrowser build .zip
  • Create Release page on GitHub with release notes and release files
  • Update GitHub Pages website for release
  • Update latest_version.txt with actual .exe assembly version.

Release Smoke Test Procedure

  • Events Tracker
    • Verify all world events are displayed
    • Verify "Show Inactive Events", "Show Completed Events", and "Show Waypoint-Code Copy Buttons" options
    • Verify Waypoint-Code Copy
    • Verify Standard vs Adjusted time tables
    • Verify Auto-Detect Completion
  • Event Notifications
    • Verify Notifications Duration setting
    • Verify Event-Notification Time setting for 1 or more world events
  • WvW Tracker
    • Verify Vertical/Horizontal Orientation
    • Verify Show Distances option and Distance Units
    • Verify Show/Hide of objectives by team and type
    • Verify Sort By options
    • Verify objective names options
    • Verify player-map auto-detection
    • Verify map override options
    • Verify right-click copy options
  • WvW Notifications
    • Verify Notifications Duration setting
    • Verify 1 or more notification-selection options
  • TP Calculator
    • Verify basic calculation, with non-default buy price, sell price, and quantity
    • Verify reset button
  • Ectoplasm Salvage Helper
  • Price Tracker
    • Add 2 or more items to track (use recently-added items)
    • Verify basic historical price graphing
    • Verify Upper/Lower limit highlighting
  • Price Notifications
    • Verify Buy Order notifications
    • Verify Sell Listing notifications
    • Verify re-display interval setting
    • Verify notifications duration setting
    • Verify copy/paste name and chat-code options
  • Dungeons Tracker
    • Verify basic completed/not-completed check-marks
    • Verify 1 or more auto-completion detections
  • Dungeons Timer
    • Verify start/stop/pause
    • Verify auto-start/stop
    • Verify best/average time tracking
  • Tasks Tracker
    • Verify add task
      • Verify task icon item and custom URL
      • Verify description
      • Verify Can Complete on/off
      • Verify Include Location on/off
      • Verify Waypoint Code
    • Verify edit task
    • Verify sort setting
    • Verify distance units setting
    • Verify show completed tasks setting
    • Verify show tasks not on current map setting
    • Verify distance/direction display
    • Verify Load of tasks .xml file
    • Verify Import of tasks .xml file
    • Verify Export of tasks .xml file
  • Zone Completion Assistant
    • Verify basic distance/direction usage across 2 or more in-game maps
    • Verify automatic unlock for 1 or more map objectives
    • Verify show/hide of map objective types setting
  • Teamspeak Overlay
    • Verify basic voice chat talk display
    • Verify show/hide of channel box
    • Verify show/hide of chat entry box
    • Verify show/hide of enter/exit notifications
    • Verify channel switch
    • Verify channel client list popup
    • Verify ability to send chats
  • Web Browser (if included)
    • Verify basic usage of GW2 Wiki
    • Verify transparency slider
    • Verify refresh button
    • Verify 1 or more bookmarks
    • Verify ability to create new bookmarks
  • General Settings
    • Verify Show Notification Borders on/off
    • Verify Auto-Fade Window Borders on/off
    • Verify Non-Interactive Windows on/off
    • Verify Overlay Menu Icon on/off
    • Verify Auto-Hide Overlay Menu Icon when GW2 not running on/off
    • Verify Auto-Hide Overlay Menu Icon when GW2 loses focus on/off
    • Verify Auto-Hide All Windows when GW2 not running on/off
    • Verify Auto-Hide All Windows when GW2 loses focus on/off
  • Hotkeys
    • Verify ability to create 1 or more hotkeys
    • Verify ability to remove hotkeys
    • Verify hotkey persistence (close application, start application)
    • Verify functionality of 1 or more hotkeys
  • Languages
    • Verify ability to select English and display of basic strings
    • Verify ability to select Spanish and display of basic strings
    • Verify ability to select French and display of basic strings
    • Verify ability to select German and display of basic strings
    • Verify ability to select Russian and display of basic strings
  • Miscellaneous
    • Verify About window for correctness
    • Verify Logging on/off and generation of logs
    • Verify Help link in menu
    • Verify ability to move the Overlay Menu Icon
    • Verify basic open/close of application with several overlay utilities open