Changes between Version 27 and Version 28 of DevNotes/Processeses/DeploymentProcess

Timestamp:

Feb 10, 2019 9:29:44 PM (5 years ago)

Author:

butler

Comment:

—

DevNotes/Processeses/DeploymentProcess

@@ -51 +51 @@
    * Windows: `setupSasView-V.v.v-x64.exe`
    * mac: `SasView-V.v.v-MacOSX.dmg`
- * The portion of the release notes in the RELEASE.rst for this new release version should be entered in the Release Description section (i.e do not copy the full release notes which includes notes for ALL previous versions as well). Also a copy of the ''Acknowledgment and citation'' and ''Bug Reporting'' sections should be included at the end of the Release Description section.
-=== update posted documentation ===
-Currently we maintain both an html and a PDF copy of the documentation available on the !SasView website. Make sure to follow '''BOTH''' steps below. 
- * The documentation folder contents (html version) needs to be moved to the sasview.github.io repo under `/docs`.
-  * The first step it to git create a new folder (docs_x.y.z) under `docs/old_docs` where x.y.z is the version number being superseded (i.e. the version of the docs currently in the repo).
-  * Git move all the folders and files currently under docs to `docs/old_docs/docs_x.y.z`
-  * Git copy the new html docs (all folders and files) to `docs`
-    * '''NOTE:''' While the docs could be built locally, for consistency with the release docs it is strongly recommended that the release version be installed locally and the cocs copied from the install path. These can just be git copied into the github.io repo folder.
-  * Commit and push these changes
- * The documentation is also built as a PDF and the PDF link for the website also needs to be updated to the new PDF version.
-   * Again, the first step is to git move the !SasViewDocumentation.pdf to downloads/Old_SasViewDoucmentation/
-   * The new PDF is available on the Jenkins Master Build tab of the OSX and Ubuntu builds only. **NOTE:** they are **not** currently available in any of the release builds which means they should be downloaded from Mater build immediately after last commits before tagging a release.  This should be changed to add a PDF build on the release servers at some point.
-   * PDF should be downloaded as !SasViewDocumentation.pdf.
-   * The pdf should then be git copied or git moved to the sasview.github.io/downloads folder.
-   * Commit and push changes
+ * The portion of the release notes in the RELEASE.rst for this new release version should be entered in the Release Description section (i.e do not copy the full release notes which includes notes for ALL previous versions as well). Also a copy of the ''Acknowledgment and citation'' and ''Bug Reporting'' sections should be included at the end of the Release Description section... with the correct DOI and version numbers of course.
 == 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. Because the release build servers are different than the developer build servers, build server fixes and dependency updates may not have been propagated over to the release server so some rudimentary testing should be done to double check that all is well.
  * Once final approval is given
+   * Update the github release page to remove the `pre-release` tag which will make this now the current release found by !SasView web pages.
    * 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.
-   * Update the github release page and remove the pre-release tag
+   * Finally update the website links to the documentation to point to the new versions - see next steps
 
+=== update posted documentation ===
+Currently we maintain both an html and a PDF copy of the documentation available on the !SasView website. Make sure to follow '''BOTH''' steps below.
+
+==== HTML version ====
+ * The documentation folder contents (html version) needs to be moved to the docs repo.
+   * '''NOTE:''' this is '''no longer''' in the sasview.github.io website repository. It is in its own separate repository called docs
+  * The first step it to git create a new folder (docs_x.y.z) under `docs/old_docs` where x.y.z is the version number being superseded (i.e. the version of the docs currently in the repo).
+  * Git move all the folders and files currently under docs to `old_docs/docs_x.y.z`
+  * Git copy the new html docs (all folders and files) to the docs repository
+    * '''NOTE:''' While the docs could be built locally, for consistency with the release docs it is strongly recommended that the release version be installed locally and the docs copied from the install path. These can just be git copied into the docs repo folder.
+  * Commit and push these changes
+==== PDF Version ====
+ * The documentation is also built as a PDF and the PDF link for the website also needs to be updated to the new PDF version.
+   * '''NOTE:''' the downloads folder containing the PDF is '''still''' in the sasview.github.io website repository
+   * Again, the first step is to git move the !SasViewDocumentation.pdf to downloads/Old_SasViewDoucmentation/
+    * '''NOTE:''' It should be renamed to SasViewDocumentation_X.y.z.pdf where X.y.z is the version number for that documentation file
+   * The new PDF is available on the Jenkins Master Build tab of the OSX and Ubuntu builds only. **NOTE:** they are **not** currently available in any of the release builds which means they should be downloaded from Master build immediately after last commits before tagging a release.  This should be changed to add a PDF build on the release servers at some point.
+   * PDF should be downloaded as !SasViewDocumentation.pdf.
+   * The pdf should then be git copied or git moved to the sasview.github.io/downloads folder.
+   * Commit and push changes
 
 == Uploading sasmodels to pypi ==