Skip to content

Release Checklist

Chris Meyer edited this page Mar 6, 2018 · 12 revisions

One way of using this checklist is to copy it to another page for a specific release and then go through the checkboxes.

  • Tests pass on all platforms.
  • Basic user testing on all platforms.
  • Camera and Scan tests pass on all platforms.
  • Camera and Scan memory leaks have been checked (overnight).
  • Essential applications tested (tuning, click-to-shift, eels-analysis, zlp-measurement, drift-measurement).
  • Basic frame rate and latency tests have passed.
  • Import nionlib works and runs basic tests.
  • Run a test on Run Script dialog to make sure imports and threading works.
  • Release notes and versioning.
  • Tag all releases in svn and git.
  • Update user guide with any new features.
  • Facade updated, documented, tested, versioning.
  • Generate typeshed files and ensure it imports cleanly. (api_tool)
  • Generate quick-ref files. (api_tool)
  • Generate API documentation files (website). Requires typeshed update first. (api_tool)
  • Generate proxy files for connection. (api_tool: Classes.py)
  • Generate FacadeQueued file (see notes in file; copy from nionlib). (api_tool)
  • Push any open source packages to PyPI.
  • Tag nionui-launcher for builds on Travis.
  • Update website with download instructions.
  • Upload versions to website.
  • Download and test or check checksums of online versions.
  • Tag and build stable readthedocs documentation (explicit build seems to be required).
  • Send email to mailing list announcing new version.
Clone this wiki locally