Merge pull request #2236 from SCIInstitute/set-6.6.0-dev

Set version to 6.6.0 dev
SCIInstitute · Apr 20, 2024 · b774a53 · b774a53
2 parents 92141ee + 181ece4
commit b774a53
Show file tree

Hide file tree

Showing 11 changed files with 85 additions and 21 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -4,9 +4,9 @@ cmake_minimum_required(VERSION 3.20)
 # SHAPEWORKS VERSION
 ###########################################
 SET(SHAPEWORKS_MAJOR_VERSION 6 CACHE INTERNAL "Major version number" FORCE)
-SET(SHAPEWORKS_MINOR_VERSION 5 CACHE INTERNAL "Minor version number" FORCE)
+SET(SHAPEWORKS_MINOR_VERSION 6 CACHE INTERNAL "Minor version number" FORCE)
 SET(SHAPEWORKS_PATCH_VERSION 0 CACHE INTERNAL "Patch version number" FORCE)
-SET(SHAPEWORKS_VERSION_STRING "6.5.0")
+SET(SHAPEWORKS_VERSION_STRING "6.6.0-dev")
 SET(SHAPEWORKS_VERSION "${SHAPEWORKS_MAJOR_VERSION}.${SHAPEWORKS_MINOR_VERSION}.${SHAPEWORKS_PATCH_VERSION}")
 
 # First, check that files were checked out properly using git-lfs

diff --git a/Python/shapeworks/shapeworks/utils.py b/Python/shapeworks/shapeworks/utils.py
@@ -172,7 +172,7 @@ def compute_line_indices(n, is_closed=True):
 
 
 def get_api_version():
-    return "6.5"
+    return "6.6"
 
 
 def set_sw_logger(log_object):

diff --git a/Studio/Python/PythonWorker.h b/Studio/Python/PythonWorker.h
@@ -18,7 +18,7 @@ class PythonWorker : public QObject {
   Q_OBJECT
 
  public:
-  constexpr static const char* python_api_version = "6.5";
+  constexpr static const char* python_api_version = "6.6";
 
   PythonWorker();
   ~PythonWorker();

diff --git a/docs/dev/release-process.md b/docs/dev/release-process.md
@@ -0,0 +1,63 @@
+# ShapeWorks Release Process
+
+This document outlines the steps to release a new version of ShapeWorks.
+
+
+* Create a new branch for the release.  E.g. `git co -b release_v6.5`
+
+* Update the version number in `CMakeLists.txt`
+
+```
+SET(SHAPEWORKS_MAJOR_VERSION 6 CACHE INTERNAL "Major version number" FORCE)
+SET(SHAPEWORKS_MINOR_VERSION 5 CACHE INTERNAL "Minor version number" FORCE)
+SET(SHAPEWORKS_PATCH_VERSION 0 CACHE INTERNAL "Patch version number" FORCE)
+SET(SHAPEWORKS_VERSION_STRING "6.5.0-RC1")
+SET(SHAPEWORKS_VERSION "${SHAPEWORKS_MAJOR_VERSION}.${SHAPEWORKS_MINOR_VERSION}.${SHAPEWORKS_PATCH_VERSION}")
+```
+
+* Confirm the API version is set correctly in the following files
+
+TODO - This should be automated from a single place
+
+- `Studio/Python/PythonWorker.h`
+
+```
+  constexpr static const char* python_api_version = "6.5";
+```
+
+- `Python/shapeworks/shapeworks/utils.py`
+
+```
+def get_api_version():
+    return "6.5"
+```
+
+- `install_shapeworks.sh` 
+
+```
+SW_MAJOR_VERSION=6.5
+```
+
+- `install_shapeworks.bat`
+
+```
+python -c "import sys; print('\n'.join(sys.path))" > "%USERPROFILE%\.shapeworks\python_path_6.5.txt"
+python -c "import sys; print(sys.prefix)" > "%USERPROFILE%\.shapeworks\python_home_6.5.txt"
+echo %PATH% > "%USERPROFILE%\.shapeworks\path_6.5.txt"
+```
+
+* Update Release Notes
+
+- Update `docs/about/release_notes.md` with the new release notes
+
+* Create Walkthrough Video
+
+* Update Documentation
+- Update release screenshot in `docs/index.md`
+- Add tour video to `docs/index.md`
+
+* When release candidate is final, set the version number in `CMakeLists.txt` to the final version number
+
+* After the release, set the version to the next development version
+
+
diff --git a/docs/index.md b/docs/index.md
@@ -52,17 +52,17 @@ Its optimized approach offers increased power for testing biological hypotheses
 *Part 1: Statistical Shape Modeling & ShapeWorks*  
 Speakers: Shireen Elhabian and Alan Morris
 
-<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks-SB3C-PartA.mp4" autoplay muted loop controls style="width:100%"></p>
+<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks-SB3C-PartA.mp4" muted loop controls style="width:100%"></p>
 
 *Part 2: ShapeWorks Success Stories in Orthopedics*   
 Speakers: Heath Henninger, Andrew Anderson, and Amy Lenz
 
-<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks-SB3C-PartB.mp4" autoplay muted loop controls style="width:100%"></p>
+<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks-SB3C-PartB.mp4" muted loop controls style="width:100%"></p>
 
 *Part 3: Next Generation of ShapeWorks*   
 Speakers: Shireen Elhabian, Andrew Anderson, Penny Atkins, and Riddhish Bhalodia
 
-<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks-SB3C-PartC.mp4" autoplay muted loop controls style="width:100%"></p>
+<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks-SB3C-PartC.mp4" muted loop controls style="width:100%"></p>
 
 
 ## ShapeWorks in Action!
@@ -81,25 +81,25 @@ Now enjoy some tour videos for different recent software releases.
 <p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks6.5.mp4" autoplay muted loop controls style="width:100%"></p>
 
 *ShapeWorks 6.4 tour - Multi-level PCA, Improved Constraints, Python Docs, and more ...*
-<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks6.4.mp4" autoplay muted loop controls style="width:100%"></p>
+<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks6.4.mp4" muted loop controls style="width:100%"></p>
 
 *ShapeWorks 6.3 tour - Landmarks, cutting planes, free form constraints in Studio, and more ...*
-<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks6.3.mp4" autoplay muted loop controls style="width:100%"></p>
+<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks6.3.mp4" muted loop controls style="width:100%"></p>
 
 *ShapeWorks 6.2 tour - DeepSSM in Studio, multi-domain alignments, shape evaluation charts, scalar and opacity controls, and more ...*
-<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks6.2.mp4" autoplay muted loop controls style="width:100%"></p>
+<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks6.2.mp4" muted loop controls style="width:100%"></p>
 
 *ShapeWorks 6.1 tour - multi-domain support, mesh grooming, improved models for complex anatomies, and more ...*
-<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks6.1.mp4" autoplay muted loop controls style="width:100%"></p>
+<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/ShapeWorks6.1.mp4" muted loop controls style="width:100%"></p>
 
 *ShapeWorks 6.0 tour - mesh support and more in ShapeWorks Studio*
-<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/studio_6.0_tour.mp4" autoplay muted loop controls style="width:100%"></p>
+<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/studio_6.0_tour.mp4" muted loop controls style="width:100%"></p>
 
 *ShapeWorks 5.5 tour - feature support in ShapeWorks Studio*
-<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/studio_5.5_tour.mp4" autoplay muted loop controls style="width:100%"></p>
+<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/studio_5.5_tour.mp4" muted loop controls style="width:100%"></p>
 
 *Grooming segmentations, optimizing correspondences, and analyzing shape models in ShapeWorks Studio*   
-<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/studio_ellipsoid.mp4" autoplay muted loop controls style="width:100%"></p>
+<p><video src="https://sci.utah.edu/~shapeworks/doc-resources/mp4s/studio_ellipsoid.mp4" muted loop controls style="width:100%"></p>
 
 
 

diff --git a/docs/users/Linux_README.txt b/docs/users/Linux_README.txt
@@ -1,5 +1,5 @@
 ==========================================
- ShapeWorks v6.4.1 - Released May 2023
+ ShapeWorks
 ==========================================
 
 The ShapeWorks software is an open-source distribution of a new method for

diff --git a/docs/users/Mac_README.txt b/docs/users/Mac_README.txt
@@ -1,5 +1,5 @@
 ==========================================
- ShapeWorks v6.4.1 - Released May 2023
+ ShapeWorks
 ==========================================
 
 The ShapeWorks software is an open-source distribution of a new method for

diff --git a/docs/users/Windows_README.txt b/docs/users/Windows_README.txt
@@ -1,5 +1,5 @@
 ==========================================
- ShapeWorks v6.4.1 - Released May 2023
+ ShapeWorks
 ==========================================
 
 The ShapeWorks software is an open-source distribution of a new method for

diff --git a/install_shapeworks.bat b/install_shapeworks.bat
@@ -39,7 +39,7 @@ call .\Installation\install_python_module.bat
 call .\Installation\conda_env_setup.bat
 
 md "%USERPROFILE%\.shapeworks"
-python -c "import sys; print('\n'.join(sys.path))" > "%USERPROFILE%\.shapeworks\python_path_6.5.txt"
-python -c "import sys; print(sys.prefix)" > "%USERPROFILE%\.shapeworks\python_home_6.5.txt"
-echo %PATH% > "%USERPROFILE%\.shapeworks\path_6.5.txt"
+python -c "import sys; print('\n'.join(sys.path))" > "%USERPROFILE%\.shapeworks\python_path_6.6.txt"
+python -c "import sys; print(sys.prefix)" > "%USERPROFILE%\.shapeworks\python_home_6.6.txt"
+echo %PATH% > "%USERPROFILE%\.shapeworks\path_6.6.txt"
 call conda info
diff --git a/install_shapeworks.sh b/install_shapeworks.sh
@@ -2,7 +2,7 @@
 # Installs conda environment for building ShapeWorks
 #
 
-SW_MAJOR_VERSION=6.5
+SW_MAJOR_VERSION=6.6
 
 echo ""
 echo "Note: this script only supports bash and zsh shells "

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -119,6 +119,7 @@ nav:
    - 'Getting Started with GitHub Actions':  'dev/gh-actions.md'
    - 'Getting Started with Markdown':        'dev/markdown.md'
    - 'Adding to PATH Environment Variable':  'dev/paths.md'
+   - 'Release Process':                      'dev/release-process.md'
 
 - Python API Reference: 'python/python-api.md'