Changes between Version 19 and Version 20 of DevNotes/Processeses/DeploymentProcess

Timestamp:

Oct 5, 2018 6:01:47 PM (6 years ago)

Author:

butler

Comment:

—

DevNotes/Processeses/DeploymentProcess

@@ -19 +19 @@
 
 == Penultimate release steps performed by the release manager ==
- * Update the sasview/README.txt with the latest version release notes
+ * Update the /sasview/docs/sphinx-docs/source/user/RELEASE.rst with the latest version of the release notes
  * If this is a full release, get the Zenodo DOI
+ * If this is a full release, update the Zenodo and version number in src/sas/sasview/local_config.py
  * 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/local_config.py (where the DOI and vers number go for the about box - should have been done when updating with the Zenodo number above)
+   * /sasview/docs/sphinx-docs/source/user/RELEASE.rst (should have been done as part of updating release notes above)
    * 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.
+   * NOTE: 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.
+   * Tag sasmodels commit point to be used with this release. We should only be using tagged version of sasmodels in a !SasView release unless there is a compelling reason to release from the current sasmodels HEAD. Remember to update version number in sasmodels/__init__.py file.
+   * Tag the appropriate !SasView commit point for the release.
    * 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:
+ * Once the build process is complete, download the mac and windows builds from the Jenkins release 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.
+ * An abbreviated version of the  release notes in the README.rst 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)
@@ -43 +44 @@
  * 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.
+ * Once final approval is given, the release number should 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. 
+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 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