Release checklist

General steps

• Check commits since previous release (tag) using Github's compare page (docs)
• List things that need testing (write down in WiFi-Box-testing)
• Update FIRMWARE-VERSION
  • We follow SemVer rules
  • for beta versions we add a letter suffix to version like 0.11.0-a
• Update ReleaseNotes.md

Steps for Beta release

• Check the 3 repo's in the customfeeds folder (client, firmware, print3d). Make sure that:

  • You're in the right branch (beta's we release from develop, stable versions from master)
  • You have the latest commits

• Build image

• Install image on WiFi-Box using scp, ssh and sysupgrade

• Perform basic tests (WiFi-Box-testing)

• When issues arise, fix them before continuing.

• Upload beta firmware update publish-wifibox-release.lua

• Update the WiFi-Box using the 'Firmware update' option on http://connect.doodle3d.com

• Create 3 releases on github (read docs). Because a Doodle3D WiFi-Box release includes 3 repo's we tag them all, whether there where changes or not. This way we can check what version is included in images. Make sure to select the right target for your release: usually develop for beta's, master for stables.

  • doodle3d-firmware/releases
  • doodle3d-client/releases
  • print3d/releases

Steps for Stable release

When after testing the beta release is considered stable you can release the stable version.

• Update FIRMWARE-VERSION

  • (remove the suffix for example: 0.11.0-a becomes 0.11.0)

• Update ReleaseNotes.md

• commit, merge (from develop to master) and sync all 3 repositories.

• Follow the upload, test, update and publish steps similar to releasing a beta but now for the stable.

• Create a new release for each repo on github but use master as target.

• If any changes have been made to the API, make sure those changes are marked with the new version (e.g. 'introduced in v...') in the API documenation.