Merge develop, resolve conflicts

Author: Amir Roth

.github/workflows/README.md

@@ -15,9 +15,12 @@ This README is really just a place to drop current status while I figure out wha
   - Linux takes 5 minutes and Windows takes 9 minutes
 - build_wheels.yml
   - Runs on demand, on Linux only for now
-- release_*.yml
+- release_documentation.yml
   - Only works on tags
-  - Runs on all three platforms
+  - Build and publish the PDF documentation.
+- release_linux.yml, release_mac.yml, release_windows.yml
+  - Only work on tags
+  - Build and publish the platform-specific release packages for Linux, macOS, and Windows
 - test_code_integrity.yml
   - Runs on Linux, about 22 minutes
 - test_debug_builds.yml

.github/workflows/release_documentation.yml

@@ -0,0 +1,90 @@
+name: Release Documentation
+
+on:
+  push:
+    tags:
+      - '*'
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  PYTHON_VERSION: '3.12'
+
+jobs:
+  build_release_documentation:
+    name: Build and Package Documentation
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+
+    steps:
+    - name: Checkout EnergyPlus
+      uses: actions/checkout@v6
+
+    - name: Set up Python ${{ env.PYTHON_VERSION }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+
+    - name: Install LaTeX dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y texlive texlive-xetex texlive-science zip
+
+    - name: Configure documentation build
+      run: cmake -S doc -B build/doc-release -DTEX_INTERACTION:STRING=batchmode
+
+    - name: Build documentation
+      run: cmake --build build/doc-release --target package -j $(nproc)
+
+    - name: Convert documentation tarball to zip
+      run: |
+        archive=$(find "$GITHUB_WORKSPACE/build/doc-release" -maxdepth 1 -name 'EnergyPlus-PDFDocumentation-*.tar.gz' -print -quit)
+        if [ -z "$archive" ]; then
+          echo "Expected documentation tarball was not found"
+          exit 1
+        fi
+        zip_path="${archive%.tar.gz}.zip"
+        temp_dir=$(mktemp -d)
+        trap 'rm -rf "$temp_dir"' EXIT
+        tar -xzf "$archive" -C "$temp_dir"
+        (
+          cd "$temp_dir"
+          zip -r "$zip_path" .
+        )
+
+    - name: Upload documentation tar.gz artifact
+      uses: actions/upload-artifact@v7
+      with:
+        name: documentation-tar-gz
+        path: build/doc-release/EnergyPlus-PDFDocumentation-*.tar.gz
+        if-no-files-found: error
+        retention-days: 7
+
+    - name: Upload documentation zip artifact
+      uses: actions/upload-artifact@v7
+      with:
+        name: documentation-zip
+        path: build/doc-release/EnergyPlus-PDFDocumentation-*.zip
+        if-no-files-found: error
+        retention-days: 7
+
+    - name: Upload documentation tar.gz to release
+      uses: svenstaro/upload-release-action@v2
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        file: build/doc-release/EnergyPlus-PDFDocumentation-*.tar.gz
+        tag: ${{ github.ref }}
+        overwrite: true
+        file_glob: true
+
+    - name: Upload documentation zip to release
+      uses: svenstaro/upload-release-action@v2
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        file: build/doc-release/EnergyPlus-PDFDocumentation-*.zip
+        tag: ${{ github.ref }}
+        overwrite: true
+        file_glob: true

.github/workflows/test_code_integrity.yml

@@ -7,6 +7,9 @@ on:
     branches: [ develop ]
   workflow_dispatch:
 
+env:
+  Python_REQUIRED_VERSION: 3.12.3  # 3.12.2 not available on Ubuntu 24 GHA
+
 jobs:
   code_integrity_checks:
     name: Static Code Analysis
@@ -16,10 +19,15 @@ jobs:
         with:
           fetch-depth: 2
 
+      - name: Set up Python ${{ env.Python_REQUIRED_VERSION }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.Python_REQUIRED_VERSION }}
+
       - name: Pip install dependencies
         if: always()
         run: |
-          pip install pre-commit tabulate
+          python -m pip install pre-commit tabulate
 
       - name: Run pre-commit
         id: pre_commit
@@ -202,7 +210,7 @@ jobs:
           -D__cppcheck__ -UEP_Count_Calls -DEP_NO_OPENGL -UGROUND_PLOT -DLINK_WITH_PYTHON -DMSVC_DEBUG -DSKYLINE_MATRIX_REMOVE_ZERO_COLUMNS -U_OPENMP -Ugeneratetestdata
           -DEP_cache_GlycolSpecificHeat -DEP_cache_PsyTsatFnPb -UEP_nocache_Psychrometrics -UEP_psych_errors -UEP_psych_stats
           --force
-          --std=c++17
+          --std=c++20
           --inline-suppr
           --suppress=missingInclude
           --suppress=missingIncludeSystem
@@ -215,35 +223,6 @@ jobs:
           --enable=all
           -j $(nproc)
           --template='[{file}:{line}]:({severity}),[{id}],{message}'
-          --suppress="uninitvar:*" \
-          --suppress="arrayIndexThenCheck:*" \
-          --suppress="checkLevelNormal:*" \
-          --suppress="constParameterPointer:*" \
-          --suppress="constParameterReference:*" \
-          --suppress="constVariable:*" \
-          --suppress="constVariablePointer:*" \
-          --suppress="constVariableReference:*" \
-          --suppress="cstyleCast:*" \
-          --suppress="duplicateCondition:*" \
-          --suppress="duplicateExpression:*" \
-          --suppress="knownConditionTrueFalse:*" \
-          --suppress="multiCondition:*" \
-          --suppress="noExplicitConstructor:*" \
-          --suppress="passedByValueCallback:*" \
-          --suppress="redundantAssignment:*" \
-          --suppress="redundantCondition:*" \
-          --suppress="redundantInitialization:*" \
-          --suppress="sameIteratorExpression:*" \
-          --suppress="shadowFunction:*" \
-          --suppress="shadowVariable:*" \
-          --suppress="unassignedVariable:*" \
-          --suppress="unmatchedSuppression:*" \
-          --suppress="unpreciseMathCall:*" \
-          --suppress="unreadVariable:*" \
-          --suppress="useInitializationList:*" \
-          --suppress="useStlAlgorithm:*" \
-          --suppress="uselessAssignmentArg:*" \
-          --suppress="uselessCallsSubstr:*" \
           ./src
           3>&1 1>&2 2>&3 | tee cppcheck.txt
 

.github/workflows/test_pull_requests.yml

@@ -23,22 +23,30 @@ jobs:
           macos_dev_target: 14.0
           arch: arm64
           python-arch: arm64
+          enable_pch: ON
           run_regressions: true
           pretty: "Mac arm64"
         - os: ubuntu-24.04
           arch: x86_64
           python-arch: x64
+          enable_pch: ON
           run_regressions: true
           pretty: "Ubuntu 24.04"
         - os: windows-2022
           arch: x86_64
           python-arch: x64
+          enable_pch: OFF
           run_regressions: false
           pretty: "Windows x64"
 
     steps:
 
-    - uses: actions/checkout@v6
+    - name: Checkout PR head
+      uses: actions/checkout@v6
+      with:
+        repository: ${{ github.event.pull_request.head.repo.full_name }}
+        ref: ${{ github.event.pull_request.head.sha }}
+        fetch-depth: 0
 
     - name: Setup System
       id: setup-runner
@@ -50,21 +58,26 @@ jobs:
     - name: Get Develop and Branch Git SHA
       shell: bash
       run: |
-        echo "Figuring out the develop GIT SHA"
-        # github.event.pull_request.base.sha points to develop at the time the PR was created, not the current one
-        DEVELOP_SHA=$(git ls-remote https://github.com/$GITHUB_REPOSITORY.git develop | cut -f1 | cut -c1-10)
-        echo "Develop GIT SHA is '${DEVELOP_SHA}'"
+        echo "Figuring out the develop GIT SHA already merged into the PR branch"
+        BASE_BRANCH="${{ github.base_ref }}"
+        if git remote get-url upstream >/dev/null 2>&1; then
+          git remote set-url upstream "https://github.com/$GITHUB_REPOSITORY.git"
+        else
+          git remote add upstream "https://github.com/$GITHUB_REPOSITORY.git"
+        fi
+        git fetch --no-tags upstream "refs/heads/${BASE_BRANCH}:refs/remotes/upstream/${BASE_BRANCH}"
+        DEVELOP_SHA=$(git merge-base HEAD "upstream/${BASE_BRANCH}")
+        echo "Develop GIT SHA merged into this branch is '${DEVELOP_SHA}'"
         echo "DEVELOP_SHA=$DEVELOP_SHA" >> $GITHUB_ENV
 
         CURRENT_HEAD_SHA=${{ github.event.pull_request.head.sha }}
         echo "Current Branch HEAD SHA is '${CURRENT_HEAD_SHA}'"
-        echo "CURRENT_HEAD_SHA=$DEVELOP_SHA" >> $GITHUB_ENV
+        echo "CURRENT_HEAD_SHA=$CURRENT_HEAD_SHA" >> $GITHUB_ENV
 
-        echo "Current merge commit SHA is '${GITHUB_SHA}'"
+        echo "GitHub synthetic merge commit SHA is '${GITHUB_SHA}'"
         echo "::endgroup::"
-        # We default to using PCH, in case we don't find the baseline reg tests,
-        # since it speeds up the build significantly and we'll build TWICE
-        echo "ENABLE_PCH=ON" >> $GITHUB_ENV
+        # Default PCH behavior is per-platform, then regression-cache hits may override it.
+        echo "ENABLE_PCH=${{ matrix.enable_pch }}" >> $GITHUB_ENV
 
     - name: Baseline Regression Testing caching
       uses: actions/cache@v5
@@ -92,8 +105,6 @@ jobs:
         restore-keys: |
           ccache-${{ matrix.os }}-${{ steps.setup-runner.outputs.compiler-id }}-${{ github.head_ref }}
           ccache-${{ matrix.os }}-${{ steps.setup-runner.outputs.compiler-id }}-${{ env.DEVELOP_SHA }}
-          ccache-${{ matrix.os }}-${{ steps.setup-runner.outputs.compiler-id }}-
-          ccache-${{ matrix.os }}-
 
     - name: Did restoring the CCache-cache work?
       shell: bash
@@ -140,7 +151,8 @@ jobs:
       if: matrix.run_regressions && steps.cachebaselineregression.outputs.cache-hit != 'true'
       uses: actions/checkout@v6
       with:
-        ref: develop
+        repository: ${{ github.repository }}
+        ref: ${{ env.DEVELOP_SHA }}
         clean: false # Do NOT wipe the build/ and .ccache folder (`git clean -ffdx && git reset --hard HEAD`)
 
     - name: Baseline Configure and Build
@@ -184,6 +196,8 @@ jobs:
       if: matrix.run_regressions && steps.cachebaselineregression.outputs.cache-hit != 'true'
       uses: actions/checkout@v6
       with:
+        repository: ${{ github.event.pull_request.head.repo.full_name }}
+        ref: ${{ env.CURRENT_HEAD_SHA }}
         clean: false # Do NOT wipe the build/ and .ccache folder (`git clean -ffdx && git reset --hard HEAD`)
 
     - name: Install problem matcher

cmake/Version.cmake

@@ -1,13 +1,13 @@
 set(CMAKE_VERSION_MAJOR 26)
-set(CMAKE_VERSION_MINOR 1)
+set(CMAKE_VERSION_MINOR 2)
 set(CMAKE_VERSION_PATCH 0)
 
-set(CMAKE_PROJECTED_RELEASE_DATE "31 March 2026")
+set(CMAKE_PROJECTED_RELEASE_DATE "30 September 2026")
 
-set(PREV_RELEASE_MAJOR 25)
-set(PREV_RELEASE_MINOR 2)
+set(PREV_RELEASE_MAJOR 26)
+set(PREV_RELEASE_MINOR 1)
 set(PREV_RELEASE_PATCH 0)
-set(PREV_RELEASE_SHA "cf73682")
+set(PREV_RELEASE_SHA "6f2e40d102")
 
 set(ENERGYPLUS_VERSION "${CMAKE_VERSION_MAJOR}.${CMAKE_VERSION_MINOR}.${CMAKE_VERSION_PATCH}")
 

doc/CMakeLists.txt

@@ -61,6 +61,24 @@ if(EXISTS ${XELATEX})
   add_subdirectory(plant-application-guide)
   add_subdirectory(using-energyplus-for-compliance)
 
+  if(NOT hasParent)
+    # Standalone build of the doc/ folder: package the generated PDFs into a TGZ/ZIP archive
+    if(WIN32)
+      set(CPACK_GENERATOR "ZIP")
+    else()
+      set(CPACK_GENERATOR "TGZ")
+    endif()
+
+    set(CPACK_PACKAGE_FILE_NAME
+      "EnergyPlus-PDFDocumentation-${CMAKE_VERSION_MAJOR}.${CMAKE_VERSION_MINOR}.${CMAKE_VERSION_PATCH}-${CMAKE_VERSION_BUILD}")
+
+    message("Installer name is set to '${CPACK_PACKAGE_FILE_NAME}'")
+
+    install(DIRECTORY "${PROJECT_BINARY_DIR}/pdf/" DESTINATION ".")
+
+    include(CPack)
+  endif()
+
 else()
   # and if it doesn't, clearly state why it fails
   message(FATAL_ERROR "Expected to find xelatex at: ${XELATEX} ; check your LaTeX installation")