Skip to content

v26.2 Packaging Touch-ups - #11826

Merged
mitchute merged 2 commits into
developfrom
release-touchups
Sep 30, 2026
Merged

mitchute merged 2 commits into
developfrom
release-touchups

Conversation

@mitchute

Copy link
Copy Markdown
Collaborator

Pull request overview

  • Minor touch-up to MacOS packaging to keep the full dev target version in the package name. i.e. "14.0" instead of "14". Like I said, minor.
  • Changes to Windows packaging to work with the recently updated GitHub ARM runners that now use Visual Studio 2026. We are still building with the Visual Studio 2022 generator and preserving the v143 toolchain to match what the previous runner was doing.

Description of the purpose of this PR

Pull Request Author

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies
  • If adding/removing any output files (e.g., eplustbl.*)
    • Update ..\scripts\Epl-run.bat
    • Update ..\scripts\RunEPlus.bat
    • Update ..\src\EPLaunch\ MainModule.bas, epl-ui.frm, and epl.vbp (VersionComments)
    • Update ...github\workflows\energyplus.py

Reviewer

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@mitchute
mitchute requested a review from jmarrec September 29, 2026 19:22
@mitchute mitchute self-assigned this Sep 29, 2026
@mitchute mitchute added the DoNotPublish Includes changes that shouldn't be reported in the changelog label Sep 29, 2026
@mitchute

mitchute commented Sep 29, 2026 •

Copy link
Copy Markdown
Collaborator Author

This built packages on the first try here: https://github.com/NatLabRockies/EnergyPlus/releases/tag/v26.2.0-RC3.1


- name: arm64
os: windows-11-arm
os: windows-11-vs2026-arm

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right.

Two points for future though:

  • We should probably use Ninja here too, like we do for pull request. (Perhaps this should use the setup-system in-repo action. Pro: less repetition; Con: more obfuscated)
  • It'd probably be a good idea to transition the x64 to windows-2025-vs2026 sooner than later. GHA supports at most two releases, so I suppose we have about a year until a Windows server 2028 is released

https://github.com/actions/runner-images/blob/main/README.md#software-and-image-support

We support (at maximum) 2 GA images and 1 beta image at a time. We begin the deprecation process of the oldest image label once the newest OS image label has been released to GA.

Python_EXECUTABLE="${{ steps.setup-python.outputs.python-path }}"
Python_EXECUTABLE="${Python_EXECUTABLE//\\//}"
cmake -G "Visual Studio 17 2022" -A ${{ matrix.vs-generator }} \
cmake -G "${{ matrix.cmake-generator }}" -A ${{ matrix.vs-generator }} -T "${{ matrix.cmake-toolset }}" \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I doubt you have to explicitly pass the toolset?

Comment on lines +98 to 102
# Visual Studio 2026 defaults to the v145 toolset. Continue building Windows
# packages with v143 while using its native ARM64 generator.
MSVC_TOOLSET_MAPPING = {
MSVC.V18: "v143",
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hum ok. I don't think that's really necessary though.

Comment on lines +158 to +160
toolset = msvc_version.toolset_name()
if toolset:
command_line.extend(["-T", toolset])

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, ok

Comment on lines +79 to +81
def toolset_name(self) -> Optional[str]:
"""Get an explicitly selected CMake toolset, when needed."""
return MSVC_TOOLSET_MAPPING.get(self)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, dict.get(val, default=None)

choices=list(MSVC),
default=None,
help="For MSVC builds, this is the Visual Studio version ('16', '17')",
help="For MSVC builds, this is the Visual Studio version ('16', '17', '18')",

@jmarrec jmarrec Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick

Suggested change
help="For MSVC builds, this is the Visual Studio version ('16', '17', '18')",
help=f"For MSVC builds, this is the Visual Studio version ({', '.join(repr(str(m.value)) for m in MSVC)})",

@jmarrec jmarrec left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is all good and can merge as-in.

I added one nitpick suggestion to avoid hardcoding the help text.

My other point is that we probably don't need to specifically use an older toolset, but it's a conservative strategy, which makes kinda sense given how close we are to release date. (The other point could be that the newer toolset wouldn't build due to new warnings or whatnot, but I have recently tested that with success locally)

I would remove the explicit toolset v143 right after release.

I don't think there is any incompatibly risk.

The MSVC 14.x toolsets (v140 through v145) share the same ABI and DLL names (vcruntime140.dll, msvcp140.dll)

The risk would be shipping a binary that relies on newer CRT libs while the running OS would have an older VC++ Redistributable.

But we redistribute the CRT libs already: see InstallRequiredSystemLibraries + CMAKE_INSTALL_UCRT_LIBRARIES cmake/Install.cmake#L622-L645

pretty: "Mac x64"
- os: macos-15
macos_dev_target: 14.0
macos_dev_target: '14.0'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, that's an annoying quirk.

unquoted 14.0 in YAML is a float. GitHub Actions turns it into the number 14 and then into the string "14" when it interpolates ${{ matrix.macos_dev_target }}.

@mitchute

Copy link
Copy Markdown
Collaborator Author

Thanks @jmarrec. Given where we are at, I'm going to merge this one as-is. Let's add these issues to the to-do list for right after release.

@mitchute
mitchute merged commit 4bd7a1f into develop Sep 30, 2026
23 checks passed
@mitchute
mitchute deleted the release-touchups branch September 30, 2026 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DoNotPublish Includes changes that shouldn't be reported in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants