Skip to content

Release Checklist

NSFW edited this page Jan 17, 2019 · 30 revisions

(This page is by and for PCM Hammer developers. If you are not a developer, you can ignore this.)

  1. Update Apps/PcmHammer/help.html (in the repository) to cover new features or other changes. View this file in the app to make sure it remains readable in the app's minimal HTML renderer. The app will normally fetch the help file from github, but you can force the app to load the file from its resources by setting a breakpoint in MainForm.LoadHelp and using "set next statement" to jump to the call to GetExecutingAssembly.
  2. Create a new Release/NNN branch.
  3. In the release branch, update versions in C# and (if appropriate) in the kernels.
  4. In the release branch, update version string in MainForm.cs
  5. Delete everything from the bin\debug directory (Build|Clean is not sufficient.)
  6. Rebuild all.
  7. Also confirm that the app loads help.html and start.txt correctly with the new version in the URLs.
  8. Copy the read-kernel.bin and write-kernel.bin files from the Kernels directory to the bin\debug directory.
  9. Zip the entire contents of the bin\debug directory.
  10. Create a new release at GitHub. Use a tag of the form YYYY.MM.DD.NN (where NN is 01, 02, or whatever)
  11. Notify the folks who have expressed interest in testing new releases.
  12. If that testing goes well, tell the world.

(At some point we'll switch to releasing non-debug builds, and perhaps create an actual installer too.)

Manual tests:

  • Get properties
  • Full read
  • Full read, cancel, wait several seconds (PCM will reboot) and try Get Properties.
  • Full read, terminate the app, reopen, confirm that Get Properties fails, use Halt Kernel, wait, confirm Get Properties works.
  • Test Write
  • Test write, terminate the app, reopen, test write again, confirm that the app discovers the running kernel.
  • Modify VIN
  • Quick Comparison
  • Write Calibration