= Release Process =
The following outlines the !SasView release process.

== Reminders ==
- The !SasView builds can be found here: [https://jenkins.esss.dk/sasview/view/Master-Builds/]. Note we are not releasing Unix versions at this time despite the Ubuntu build machine.
- The released software is available for download on [https://github.com/SasView/sasview/releases GitHub].

== Planning a new major release ==
- Releases are discussed at the bi-weekly meeting. Only planned released 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 priviledges 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 actual release process.

== Preparing a new major release ==
manager announces the process is complete
- The release manager will make sure that the version number is correctly placed in all the appropriate places.  That currently includes:
 - sasview/_init_.py
 - sasview/README.txt
 - docs/sphynx-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.
- The release manager will then announce to the team the beginning of the release process. Developers should not push anything to the !GitHub repository until the release 
- The release manager will download the mac and windows builds from the build site.
- The release manager will then tag the current repo for release and execute the release process as described at [https://help.github.com/articles/creating-releases/]. Note that the mac and windows builds will need to be renamed appropriately and uploaded as binaries along. Current naming convention is:
 - Windows: !SasView-V.v.v.exe
 - mac: !SasView-V.v.v.dmg
- The documentation folder contents 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. 
- An abbreviated version of the  release notes in the README.txt should be entered in the Release Description section.
- The release manager will email the team to announce the release process is complete.
- The team will 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.

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