Version 19 (modified by wojciech, 6 years ago) (diff)

—

Release Process

The following outlines the SasView release process.

Reminders

Planning a new major release

  • Releases are discussed at the bi-weekly meeting. Only planned releases are acceptable.
  • Once the developers are completely done with their changes and have tested their own code, they should close their ticket and announce it to the rest of the team.
  • Once all developers are done with their work, the release will be discussed at the following conference call.
  • During that call, a "release manager" will be appointed for that release. That person is responsible for following the release process below and communicating progress to the team. The release manager will need to have release privileges on the repository.
  • After a release manager has been appointed, a code freeze is declared.

Testing a new major release

  • After the code freeze, developers and chosen users will test the release candidate.
  • All bugs and issues identified will be ticketed and either fixed or discussed on the conference call to ascertain if they must be fixed (blockers) or can remain known issues to be reported in release notes and fixed in a future release.
  • Once everyone agrees that the release candidate is ready, the release manager will start the final release process.

Penultimate release steps performed by the release manager

  • Update the sasview/README.txt with the latest version release notes
  • If this is a full release, get the Zenodo DOI
  • Make sure that the version number is correctly placed in all the appropriate places. That currently includes:
    • src/sas/sasview/local_config.py (where the DOI and vers number go for the about box)
    • src/sas/sasview/_init_.py
    • installers/README.txt
    • docs/sphinx-docs/source/conf.py (change both version and release numbers)
    • sasview.latestversion has now been superseded by the json file stored at the sasview site.
  • Using instructions published at GitHub ​https://help.github.com/articles/creating-releases/
    • If necessary tag appropriate sasmodels commit point to be used with this release of SasView if not using HEAD. Remmber to update version number in sasmodels/init.py file if it is a new version release
    • Tag the appropriate SasView commit point for the release if not using HEAD.
    • Note: if decision is made to make a release from an old enough commit point that it is not available on the GitHub interface the tag can be generated using the local git interface
  • Log into the Jenkins server, navigate to the releases tab and for each platform use "configure" to edit the configuration to use the appropriate sasmodels and SasView tags for the build.
  • Next, manually launch the Jenkins build processes for each platform being supported.
  • Download the mac and windows builds from the Jenkins build tab and upload the binaries to the releases page. Note that the mac and windows builds will need to be renamed appropriately. Current naming convention is:
    • Windows: setupSasView-V.v.v.exe
    • mac: SasView-V.v.v-MacOSX.dmg
  • An abbreviated version of the release notes in the README.txt should be entered in the Release Description section.
  • The documentation folder contents (html version) needs to be moved to the sasview.github.io repo under docs (commit and push). Currently the release manager can either build the docs locally, but for consistency with the release docs it is strongly recommended that instead they install the release version and copy the docs from the install path.
  • The documentation is also built as a PDF and is available on the Jenkins build tab. The PDF should be downloaded as SasViewDocumentation.pdf from the release build. The pdf should then be moved to the sasview.github.io repo under downloads (commit and push)

Final release steps

  • The release manager will email the team to announce the release process is complete.
  • The team should download the new release to make sure it installs.
  • Once final approval is given, the release number will be updated in latestversion.json on the SasView website repo which will alert all SasView users that a new version is available.

Post release steps

Once the release is completely done and out, it is recommended that the version numbers in master get updated to the next planned release version number so that developers testing can tell easily tell they are running a post release version.  Just the init.py and possibly the sphinx conf.py should be updated at this point. 

  • src/sas/sasview/_init_.py
  • docs/sphinx-docs/source/conf.py (change both version and release numbers)

Patch releases

  • Currently patch releases follow the same process as major releases but the cycle is usually much abbreviated.

Pre releases (alpha and beta releases)

  • Pre-releases follow a much less formal acceptance process but otherwise follows the same technical process - make sure to click "This is a pre-release" check box when drafting a new release on GitHub.