Release Checklist

The purpose of this document is to establish a process and checklist for new SCRUB releases. The process assumes that all code changes have been completed and is ready for testing and subsequent release

Preparation

  • Make code changes associated with issues assigned to milestone
  • Perform unit testing for affected modules
  • Make sure that any branched code and pending pull requests have been merged
  • Update setup.cfg for new release
  • Draft new release

Checklist

  • Review CodeQL results
    • Check for commented out/debugging code
    • Make necessary code changes based on findings
  • Make updates to the integration test suite, if necessary
  • Run integration test suite
  • Run performance test case
    • Analyze and compare metrics to previous releases
  • Make any necessary updates to the SCRUB documentation

Publish Release

  • Publish the release on GitHub
    • Ensure successful completion of GitHub Action to push release to PyPi
  • Update this release checklist as necessary