Replace RELEASE_NUMBER environment variable with OVERTE_RELEASE_NUMBER cache variable.

.github/workflows/linux_server_build.yml

@@ -255,7 +255,7 @@ jobs:
     - name: Configure CMake
       shell: bash
            # This syntax requires CMake 3.23
-      run: cmake --preset conan-${BUILD_TYPE,,} -DOVERTE_RELEASE_TYPE=$OVERTE_RELEASE_TYPE $CMAKE_EXTRA
+      run: cmake --preset conan-${BUILD_TYPE,,} -DOVERTE_RELEASE_TYPE=$OVERTE_RELEASE_TYPE -DOVERTE_RELEASE_NUMBER=$RELEASE_NUMBER $CMAKE_EXTRA
 
     - name: Build Domain Server
       working-directory: build

.github/workflows/master_build.yml

@@ -15,7 +15,6 @@ env:
   BUILD_TYPE: Release
   BUILD_NUMBER: ${{ github.event.number }}_${{ github.sha }}
   GIT_COMMIT: ${{ github.sha }}
-  RELEASE_NUMBER: ${{ github.event.number }}_${{ github.sha }}
   STABLE_BUILD: 0
   UPLOAD_BUCKET: overte-public
   UPLOAD_REGION: fra1

.github/workflows/pr_build.yml

@@ -14,7 +14,7 @@ env:
   APP_NAME: interface
   BUILD_TYPE: Release
   GIT_COMMIT: ${{ github.event.pull_request.head.sha }}
-  RELEASE_NUMBER: ${{ github.event.number }}
+  # Android
   VERSION_CODE: ${{ github.event.number }}
 
   UPLOAD_BUCKET: overte-public
@@ -254,10 +254,10 @@ jobs:
       run: |
         if [[ "${{ matrix.os }}" =~ "Windows" ]]; then
           # This syntax requires CMake 3.23
-          cmake --preset conan-default -DOVERTE_RELEASE_TYPE=PR $CMAKE_EXTRA
+          cmake --preset conan-default -DOVERTE_RELEASE_NUMBER=${{ github.event.number }} -DOVERTE_RELEASE_TYPE=PR $CMAKE_EXTRA
         else
           # This syntax requires CMake 3.23
-          cmake --preset conan-${BUILD_TYPE,,} -DOVERTE_RELEASE_TYPE=PR $CMAKE_EXTRA
+          cmake --preset conan-${BUILD_TYPE,,} -DOVERTE_RELEASE_NUMBER=${{ github.event.number }} -DOVERTE_RELEASE_TYPE=PR $CMAKE_EXTRA
         fi
 
     - name: Build Application

.github/workflows/release_build.yml

@@ -17,7 +17,6 @@ env:
   BUILD_TYPE: Release
   GIT_COMMIT: ${{ github.sha }}
   PRODUCTION_BUILD: true
-  RELEASE_NUMBER: ${{ github.ref_name }}
   STABLE_BUILD: 1
   UPLOAD_BUCKET: overte-public
   UPLOAD_REGION: fra1
@@ -80,7 +79,7 @@ jobs:
       run: |
 
         echo "BUILD_NUMBER=$GIT_COMMIT_SHORT" >> $GITHUB_ENV
-        echo "ARTIFACT_PATTERN=Overte-$RELEASE_NUMBER.$INSTALLER_EXT" >> $GITHUB_ENV
+        echo "ARTIFACT_PATTERN=Overte-${{ github.ref_name }}.$INSTALLER_EXT" >> $GITHUB_ENV
 
     - uses: actions/checkout@v4
       with:
@@ -128,7 +127,7 @@ jobs:
     - name: Configure CMake
       shell: bash
            # This syntax requires CMake 3.23
-      run: cmake --preset conan-${BUILD_TYPE,,} -DOVERTE_BUILD_TYPE=PRODUCTION -DJSDOC_ENABLED:BOOL=TRUE $CMAKE_EXTRA
+      run: cmake --preset conan-${BUILD_TYPE,,} -DOVERTE_RELEASE_NUMBER=${{ github.ref_name }} -DOVERTE_BUILD_TYPE=PRODUCTION -DJSDOC_ENABLED:BOOL=TRUE $CMAKE_EXTRA
 
     - name: Build application
       shell: bash

BUILD.md

@@ -60,8 +60,6 @@ Where `/path/to/directory` is the path to a directory where you wish the build f
 #### Possible Environment Variables
 
 ```text
-// The release version, e.g., 2021.3.2.
-RELEASE_NUMBER
 // The build commit, e.g., use a Git hash for the most recent commit in the branch - fd6973b.
 BUILD_NUMBER
 
@@ -93,6 +91,9 @@ OVERTE_BACKTRACE_URL
 // The identifying tag of the release.
 OVERTE_BACKTRACE_TOKEN
 
+// The release version, e.g., 2021.3.2. For PR builds the PR number, e.g. 577.
+// Not used for nightlies and development builds.
+OVERTE_RELEASE_NUMBER
 // The type of release.
 OVERTE_RELEASE_TYPE=PRODUCTION|PR|DEV
 ```

INSTALLER.md

@@ -109,7 +109,7 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS
 1. Ensure you have all the prerequisites fulfilled from the [MacOS Build Guide](BUILD_OSX.md).
 2. Perform a clean CMake in your build folder. e.g.
     ```bash
-    BUILD_GLOBAL_SERVICES=STABLE USE_STABLE_GLOBAL_SERVICES=1 BUILD_NUMBER="Insert Build Identifier here e.g. short hash of your last Git commit" STABLE_BUILD=1 PRODUCTION_BUILD=1 RELEASE_NUMBER="Insert Release Version Here e.g. 1.1.0" cmake -DOVERTE_RELEASE_TYPE=PRODUCTION -DCMAKE_OSX_SYSROOT="/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.12.sdk" -DOVERTE_BUILD_SERVER=0 -DCMAKE_OSX_DEPLOYMENT_TARGET=10.12 -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl -DOSX_SDK=10.12  ..
+    BUILD_GLOBAL_SERVICES=STABLE USE_STABLE_GLOBAL_SERVICES=1 BUILD_NUMBER="Insert Build Identifier here e.g. short hash of your last Git commit" STABLE_BUILD=1 PRODUCTION_BUILD=1 cmake -DOVERTE_RELEASE_NUMBER="Insert Release Version Here e.g. 1.1.0" -DOVERTE_RELEASE_TYPE=PRODUCTION -DCMAKE_OSX_SYSROOT="/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.12.sdk" -DOVERTE_BUILD_SERVER=0 -DCMAKE_OSX_DEPLOYMENT_TARGET=10.12 -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl -DOSX_SDK=10.12  ..
     ```
 3. Pick a method to build and package your release.
 

cmake/macros/SetPackagingParameters.cmake

@@ -22,9 +22,9 @@ macro(SET_PACKAGING_PARAMETERS)
   set(BUILD_NUMBER 0)
   set(APP_USER_MODEL_ID "com.highfidelity.console-dev")
 
-  set_from_env(RELEASE_NUMBER RELEASE_NUMBER "")
   set_from_env(STABLE_BUILD STABLE_BUILD 0)
   set(OVERTE_RELEASE_TYPE "DEV" CACHE STRING "Valid options are: 'PRODUCTION', 'PR', and 'DEV'.")
+  set(OVERTE_RELEASE_NUMBER "0000.00.0" CACHE STRING "Release version number. E.g. 2025.05.1-rc1 for the first release candidate of the first release in May 2025.")
 
   set_from_env(PRELOADED_STARTUP_LOCATION PRELOADED_STARTUP_LOCATION "")
   set_from_env(PRELOADED_SCRIPT_ALLOWLIST PRELOADED_SCRIPT_ALLOWLIST "")
@@ -48,7 +48,7 @@ macro(SET_PACKAGING_PARAMETERS)
 
   if (OVERTE_RELEASE_TYPE STREQUAL "PRODUCTION")
     set(PRODUCTION_BUILD 1)
-    set(BUILD_VERSION ${RELEASE_NUMBER})
+    set(BUILD_VERSION ${OVERTE_RELEASE_NUMBER})
     set(BUILD_ORGANIZATION "Overte")
     set(HIGH_FIDELITY_PROTOCOL "hifi")
     set(HIGH_FIDELITY_APP_PROTOCOL "hifiapp")
@@ -71,8 +71,8 @@ macro(SET_PACKAGING_PARAMETERS)
 
   elseif (OVERTE_RELEASE_TYPE STREQUAL "PR")
     set(PR_BUILD 1)
-    set(BUILD_VERSION "PR${RELEASE_NUMBER}")
     set(BUILD_ORGANIZATION "Overte - PR${RELEASE_NUMBER}")
+    set(BUILD_VERSION "PR${OVERTE_RELEASE_NUMBER}")
     set(INTERFACE_ICON_PREFIX "interface-beta")
 
     # add definition for this release type
@@ -115,7 +115,7 @@ macro(SET_PACKAGING_PARAMETERS)
 
     # pass along a release number without the SHA in case somebody
     # wants to compare master or PR builds as integers
-    set(BUILD_NUMBER ${RELEASE_NUMBER})
+    set(BUILD_NUMBER ${OVERTE_RELEASE_NUMBER})
   endif ()
 
   if (APPLE)