Release v3.8.0 Tasks

[kbenne]

The purpose is this issue is to document tasks that need to be done in order to reach a 3.8.0 release. There is a separate issue that is related to the quality control steps involved in the 3.8.0 release, but the items listed here need to be addressed before we are ready to move through the QC motions. There is also another issue to iron out the big tasks, but this issue is more specific.

This is in the approximate order of operations. Please add known tasks here.

• Confirm that Ruby 3.2.2 is the correct target. @DavidGoldwasser would you be able to help get confirmation from SketchUp that they will release against the 3.2.2 version of Ruby? It will be painful if we do a Ruby update and that ends up being the wrong version.
• @kbenne Document obscure changes to loading the embedded Ruby gems. @kbenne, specifically this commit comment has information that would be good to put into a code comment. This is an obscure but important change that we are bound to forget.
• @kbenne consolidate Ruby gem loading code, or bring this change over to the classic cli implementation.
• @kbenne, @jmarrec, and @joseph-robertson Merge all of the branches going into the release into the develop branch. This includes the ruby/3.2.2https://github.com/NREL/OpenStudio/tree/ruby/3.2.2 branch. When we merge Ruby 3.2.2 to develop the CI will break and we will be flying blind for a period of time.
• @wenyikuang Move jmarrec/conan-recipes repo to an NREL repository. #5152
• @wenyikuang Establish openstudio-gems CI for Ruby 3.2.2. Currently @jmarrec is using GitHub actions to do this on his personal fork.
• @wenyikuang Fix the CI for the develop branch. This will require updating to conan2 and and Ruby 3.2.2 (assuming that ends up being the correct target)
• @jmarrec Consolidate notes on building with conan2. We have https://github.com/NREL/OpenStudio/blob/ruby/3.2.2/BUILDING.md#building-with-conan-v2 and also some (probably stale) notes in the Wiki https://github.com/NREL/OpenStudio/wiki#building-openstudio.
• @kbenne and @jmarrec Remove stale conan related build code that is no longer used in conan2 world. Specifically https://github.com/NREL/OpenStudio/blob/ruby/3.2.2/ConanInstall.cmake, but there could be other stuff.
• @kbenne integrate the latest openstudio-standards release from @mdahlhausen, however we plan to generate our first RC with the current version of standards, while we wait for the final openstudio-standards release.
• @DavidGoldwasser Review and update Ruby version requirement in assorted gemspec files. (This one is superceded by the more detailed checklist in the more recent comment)
  • https://github.com/NREL/OpenStudio-measure-tester-gem/blob/develop/openstudio_measure_tester.gemspec#L30
  • https://github.com/NREL/openstudio-extension-gem/blob/v0.8.0-rc1/openstudio-extension.gemspec#L29
  • https://github.com/NREL/openstudio-standards/blob/master/openstudio-standards.gemspec#L15
  • https://github.com/NREL/OpenStudio-workflow-gem/blob/develop/openstudio-workflow.gemspec#L19

[joseph-robertson]

FYI I marked with the "OpenStudio DSK v3.8.0 " milestone the, AFAIK, pull requests that should go into develop before the release.

[kbenne]

FYI I marked with the "OpenStudio DSK v3.8.0 " milestone the, AFAIK, pull requests that should go into develop before the release.

Perfect. I'm going to add the ones that I am aware of.

[DavidGoldwasser]

@kbenne SketchUp 2024 is out now using Ruby 3.2.2. Here is release notes https://help.sketchup.com/en/release-notes/sketchup-desktop-20240

Not sure if this note about OpenSSL is standard to Ruby 3.2.2 or something they changed? The version of OpenSSL in Ruby was updated to OpenSSL 1.1.1w

[jmarrec]

Hum, so Ruby 3.2.2 supports OpenSSL >= 1.1.1 but also > 3.x, and the standard installers are 3.x. I'm kinda annoyed they picked 1.1.1w and not 3.x (Qt 6 for eg uses 3.x.), which is what I went with for now since it followed the ruby installers...

OpenStudio/conanfile.py

Line 40 in 2ff1c1b

self.requires("openssl/[>=3 <4]")

As can be seen, Ruby 3.2.2 was using OpenSSL 3.1.0:
https://github.com/ruby/ruby/blob/e51014f9c05aa65cbf203442d37fef7c12390015/ext/openssl/openssl.gemspec#L3

I'd very much prefer to keep OpenSSL 3.x.

(I'm also hoping that the openstudio-sketchup-plugin will not have binary incompatibilities due to it)

[kbenne]

Hum, so Ruby 3.2.2 supports OpenSSL >= 1.1.1 but also > 3.x, and the standard installers are 3.x. I'm kinda annoyed they picked 1.1.1w and not 3.x (Qt 6 for eg uses 3.x.), which is what I went with for now since it followed the ruby installers...

OpenStudio/conanfile.py

Line 40 in 2ff1c1b

self.requires("openssl/[>=3 <4]")

As can be seen, Ruby 3.2.2 was using OpenSSL 3.1.0: https://github.com/ruby/ruby/blob/e51014f9c05aa65cbf203442d37fef7c12390015/ext/openssl/openssl.gemspec#L3

I'd very much prefer to keep OpenSSL 3.x.

(I'm also hoping that the openstudio-sketchup-plugin will not have binary incompatibilities due to it)

Ok well I guess this is something to confirm during testing of the RC.

[jmarrec]

• Measure Tester:
  • Remove hard dependency on ruby 2.7 as we prepare for ruby 3.2.2 OpenStudio-measure-tester-gem#79
• Extension Gem:
  • Remove hard dependency on ruby 2.7 as we prepare for ruby 3.2.2 openstudio-extension-gem#186
  • updating version, dependencies, and documentation. openstudio-extension-gem#185
• BCL Gem:
  • Remove hard dependency on ruby 2.7 as we prepare for ruby 3.2.2 bcl-gem#29
• Workflow gem:
  • Remove hard dependency on ruby 2.7 as we prepare for ruby 3.2.2 OpenStudio-workflow-gem#150
  • Fix #5101 - Update monthly reports for DistrictHeatingWater OpenStudio-workflow-gem#149

Out of our control, but for reference (I have openstudio-gems pulling from my fork in the meantime):
Update: I created an issue to port this over to a new NREL repo.

• Extend support to ruby 3.x rd2/tbd#115
• Extend support to ruby 3.x rd2/oslg#14
• Extend support to ruby 3.x rd2/osut#19

And the one to rule them all:

• Support Ruby 3.2.2 openstudio-gems#76
• - [ ] Workaround to get bundler to install in gems/ folder (not bundler/gems) even when from :git or :path openstudio-gems#77