Release Ionic

[azeey]

Timeline

Current timeline

• Feature freeze: 2024/07/26 (Friday)
• Code freeze: 2024/08/28 (Wednesday)
• Tutorial party: 2024/08/29 (Thursday) ~ 2024/09/13 (Friday)
• Internal QA: 2024/09/16 (Monday) - 2024/09/20 (Friday)
• Community meeting: 2024/09/25 (Wednesday)
• Announcement: 2024/09/30 (Monday)

During development

• Bump major version of libraries early in the development cycle (use bump_libraries template).
• Work with artist on logo.
  • Artwork announced on https://community.gazebosim.org/t/gazebo-ionic-tutorial-party-results-artwork-swag-sale-and-more/3060/1

Feature freeze

• Merge each library forward from previous versions

• Create stable branches off of main

  • gz-cmake:
    • Create a changelog PR (example): Ionic Changelog gazebosim/gz-cmake#444
    • New branch button on branches page (example). Make sure to set the Source to main.
    • Enable CI for stable branches : Use stable branch for gz-cmake4 #1164
    • Update gazebodistro: Use stable branch for gz-cmake4 gazebodistro#165
    • Update homebrew: gz-cmake4: use stable branch in url osrf/homebrew-simulation#2730
    • Run the Jenkins DSL generation job
    • Create a small PR targetting the stable branch. This could be used to update build status badges (example). Don't skip this; it is important for the next step: Update gz-cmake4 badge URLs gazebosim/gz-cmake#445
    • Update branch protections. Remember to include the abi-checker.
    • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows.
  • gz-utils:
    • Create a changelog PR (example): Update changelog and prepare for prereleases gazebosim/gz-utils#136
    • New branch button on branches page (example). Make sure to set the Source to main.
    • Enable CI for stable branches : Use stable branch for gz-utils3 #1166
    • Update gazebodistro: Use stable branch for gz-utils3 gazebodistro#167
    • Update homebrew: gz-utils3: use stable branch in url osrf/homebrew-simulation#2733
    • Run the Jenkins DSL generation job
    • Create a small PR targetting the stable branch. This could be used to update build status badges (example). Don't skip this; it is important for the next step: Update badges to point to gz-utils3 branch gazebosim/gz-utils#138
    • Update branch protections. Remember to include the abi-checker.
    • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows
  • gz-math:
    • Create a changelog PR (example): Ionic Changelog gazebosim/gz-math#618
    • New branch button on branches page (example). Make sure to set the Source to main.
    • Enable CI for stable branches : Use stable branch for gz-math8 #1167
    • Update gazebodistro: Ionic: use stable branch for gz-math8 gazebodistro#168
    • Update homebrew: gz-math8: use stable branch in url osrf/homebrew-simulation#2735
    • Run the Jenkins DSL generation job https://build.osrfoundation.org/job/_dsl_generate_all_dsls/1050/
    • Create a small PR targetting the stable branch. This could be used to update build status badges (example). Don't skip this; it is important for the next step: README: update main branch references to gz-math8 gazebosim/gz-math#622
    • Update branch protections. Remember to include the abi-checker.
    • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows
  • sdformat:
    • Create a changelog PR (example): Ionic Changelog gazebosim/sdformat#1471
    • New branch button on branches page (example). Make sure to set the Source to main.
    • Enable CI for stable branches: Ionic CI: use stable branch for sdformat15 #1171
    • Update gazebodistro: Ionic: use stable branch for sdformat15 gazebodistro#172
    • Update homebrew: sdformat15: use stable branch osrf/homebrew-simulation#2741
    • Run the Jenkins DSL generation job
    • Create a small PR targetting the stable branch. This could be used to update build status badges (example). Don't skip this; it is important for the next step: README: update badges for sdf15 gazebosim/sdformat#1472
    • Update branch protections. Remember to include the abi-checker.
    • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows Prepare for Ionic prerelease gazebosim/sdformat#1473
  • gz-physics:
    • Create a changelog PR (example): Ionic Changelog gazebosim/gz-physics#678
    • New branch button on branches page (example). Make sure to set the Source to main.
    • Enable CI for stable branches: Ionic CI: use stable branch for gz-physics8 #1178
    • Update gazebodistro: Ionic: use stable branch for gz-physics8 gazebodistro#177
    • Update homebrew: gz-physics8: use stable branch osrf/homebrew-simulation#2754
    • Run the Jenkins DSL generation job
    • Create a small PR targetting the stable branch. This could be used to update build status badges (example). Don't skip this; it is important for the next step: README: update references from main to gz-physics8 gazebosim/gz-physics#679
    • Update branch protections. Remember to include the abi-checker.
    • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows
  • gz-msgs:
    • Create a changelog PR (example): Ionic Changelog gazebosim/gz-msgs#453
    • New branch button on branches page (example). Make sure to set the Source to main.
    • Enable CI for stable branches: Use stable branch for gz-msgs11 #1172
    • Update gazebodistro: Ionic: Use stable branch for gz-msgs11 gazebodistro#173
    • Update homebrew: Ionic: Use gz-msgs11 stable branch osrf/homebrew-simulation#2743
    • Run the Jenkins DSL generation job
    • Create a small PR targetting the stable branch. This could be used to update build status badges (example). Don't skip this; it is important for the next step: Update gz-msgs11 badge URLs gazebosim/gz-msgs#455
    • Update branch protections. Remember to include the abi-checker.
    • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows
  • gz-transport:
    • Create a changelog PR (example): Ionic Changelog gazebosim/gz-transport#523
    • New branch button on branches page (example). Make sure to set the Source to main.
    • Enable CI for stable branches: Use stable branch gz-transport14 #1173
    • Update gazebodistro: Use stable branch for gz-transport14 gazebodistro#174
    • Update homebrew: Ionic: Use gz-transport14 stable branch osrf/homebrew-simulation#2744
    • Run the Jenkins DSL generation job
    • Create a small PR targetting the stable branch. This could be used to update build status badges (example). Don't skip this; it is important for the next step: Update gz-transport14 badge URLs gazebosim/gz-transport#524
    • Update branch protections. Remember to include the abi-checker.
    • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows
  • gz-plugin:
    • Create a changelog PR (example): Ionic changelog gazebosim/gz-plugin#147
    • New branch button on branches page (example). Make sure to set the Source to main.
    • Enable CI for stable branches: Use stable branch gz-plugin3 #1176
    • Update gazebodistro: Use stable branch for gz-plugin3 gazebodistro#176
    • Update homebrew: Ionic: Use gz-plugin3 stable branch osrf/homebrew-simulation#2749
    • Run the Jenkins DSL generation job
    • Create a small PR targetting the stable branch. This could be used to update build status badges (example). Don't skip this; it is important for the next step: Update gz-plugin3 badge URLs gazebosim/gz-plugin#148
    • Update branch protections. Remember to include the abi-checker.
    • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows
  • gz-fuel-tools:
    • Create a changelog PR (example): Ionic Changelog gazebosim/gz-fuel-tools#438
    • New branch button on branches page (example). Make sure to set the Source to main.
    • Enable CI for stable branches: Use stable branch gz-fuel-tools10 #1174
    • Update gazebodistro: Use stable branch for gz-fuel-tools10 gazebodistro#175
    • Update homebrew: Ionic: Use gz-fuel-tools10 stable branch osrf/homebrew-simulation#2746
    • Run the Jenkins DSL generation job
    • Create a small PR targetting the stable branch. This could be used to update build status badges (example). Don't skip this; it is important for the next step: Update badges to point to gz-fuel-tools10 gazebosim/gz-fuel-tools#439
    • Update branch protections. Remember to include the abi-checker.
    • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows
  • gz-rendering:
    • Create a changelog PR (example): Ionic Changelog gazebosim/gz-rendering#1042
    • New branch button on branches page (example). Make sure to set the Source to main.
    • Enable CI for stable branches: Use stable branch for gz-rendering9 #1168
    • Update gazebodistro: Ionic: use stable branch for gz-rendering9 gazebodistro#169
    • Update homebrew: gz-rendering9: use stable branch osrf/homebrew-simulation#2736
    • Run the Jenkins DSL generation job
    • Create a small PR targetting the stable branch. This could be used to update build status badges (example). Don't skip this; it is important for the next step: Update badges to point to gz-rendering9 gazebosim/gz-rendering#1044
    • Update branch protections. Remember to include the abi-checker.
    • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows
  • gz-sensors:
    • Create a changelog PR (example): Update changelog gazebosim/gz-sensors#459
    • New branch button on branches page (example). Make sure to set the Source to main.
    • Enable CI for stable branches: Use stable branch for gz-sensors9 #1170
    • Update gazebodistro: Ionic: use stable branch for gz-sensors9 gazebodistro#171
    • Update homebrew: gz-sensors9: use stable branch osrf/homebrew-simulation#2739
    • Run the Jenkins DSL generation job
    • Create a small PR targetting the stable branch. This could be used to update build status badges (example). Don't skip this; it is important for the next step: Update badges to point to gz-sensors9 gazebosim/gz-sensors#463
    • Update branch protections. Remember to include the abi-checker.
    • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows
  • gz-sim:
    • Create a changelog PR (example): Update Changelog, README, and prep for 9.0.0pre1 release gazebosim/gz-sim#2554
    • New branch button on branches page (example). Make sure to set the Source to main.
    • Enable CI for stable branches: Ionic CI: use stable branch for gz-sim9 #1181
    • Update gazebodistro: Ionic: use stable branch for gz-sim9 gazebodistro#180
    • Update homebrew: gz-sim9: use stable branch osrf/homebrew-simulation#2763
    • Run the Jenkins DSL generation job
    • Create a small PR targetting the stable branch. This could be used to update build status badges (example). Don't skip this; it is important for the next step: Update Changelog, README, and prep for 9.0.0pre1 release gazebosim/gz-sim#2554
    • Update branch protections. Remember to include the abi-checker.
    • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows
  • gz-launch:
    • Create a changelog PR (example): Ionic Changelog  gazebosim/gz-launch#273
    • New branch button on branches page (example). Make sure to set the Source to main.
    • Enable CI for stable branches: Ionic CI: use stable branch for gz-launch8 #1180
    • Update gazebodistro: Ionic: use stable branch for gz-launch8 gazebodistro#179
    • Update homebrew: gz-launch8: use stable branch osrf/homebrew-simulation#2762
    • Run the Jenkins DSL generation job
    • Create a small PR targetting the stable branch. This could be used to update build status badges (example). Don't skip this; it is important for the next step: Ionic Changelog  gazebosim/gz-launch#273
    • Update branch protections. Remember to include the abi-checker.
    • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows

• Update Changelog and pre-release libraries as all beta labels are merged.

  • Ionic Changelog gazebosim/gz-cmake#444
  • gz-utils
  • Ionic Changelog gazebosim/gz-math#618

• Make collection pre-release after all libraries are pre-released.

• Update public documentation to install from pre-releases instead of nightlies (example).

Code freeze

• Choose name for next release.
  • https://community.gazebosim.org/t/name-the-next-gazebo-release-gazebo-j/3020/1
• Start T-Shirt campaign
  • https://ignition-gazebo.creator-spring.com/
• Update all repositories to default to the new stable branches.
• Hold tutorial party (example)
  • https://community.gazebosim.org/t/gazebo-ionic-test-and-tutorial-party-instructions/2989
• Update references to the release install instructions
  • Versions doc https://github.com/gazebosim/docs/blob/master/tools/versions.md
  • ROS2 Installation https://github.com/gazebosim/docs/blob/master/ros_installation.md Update "Installing Gazebo with ROS" for Ionic gazebosim/docs#502
  • ros_gz README https://github.com/gazebosim/ros_gz/blob/ros2/README.md
• PRs fixing documentation and critical bugs can be merged and pre-released
• As libraries have all their documentation reviewed:
  • Make Ionic stable releases #1184

Release day

• Make collection stable release after all libraries are released.
  • Prepare for 1.0.0 release gazebosim/gz-ionic#10
  • https://github.com/gazebo-tooling/gzdev/pull/90/files
• Make GitHub releases for all the X.0.0 versions (example)
• Update docs to say release is stable (example)
  • Prepare for Ionic release gazebosim/docs#520
• Make announcement
  • https://community.gazebosim.org/t/gazebo-ionic-release/3088/

Post-release

• Pull requests previously targeted at main:
  • Bug fixes:
    • Retarget to the new stable branch.
    • Label with beta
    • They can be merged until code freeze.
  • Backwards-compatible features, either:
    • Retarget them to the new stable branch (but they can only be merged after the stable release), or
    • Keep targeting main and backport after the stable release.
  • Breaking features:
    • Keep targeting main (i.e. they will be delayed until the next major release)
• Bump all main branches to the next major version (X.0.0~pre1)
  • Source code (example)
  • Add files to gazebodistro (example)
    • Add files for versions post-Ionic gazebodistro#182
  • Add aliases to homebrew-simulation (example)
    • Add aliases for versions post-Ionic osrf/homebrew-simulation#2833
  • Create new -release repositories (use this script)
  • Enable nightlies for all main branches on gzdev (example)
    • Enable nightlies for main branches gzdev#91
  • Execute the tick-tock's "tock" for deprecations (example)
• Enable Jenkins CI for new stable branches (example)
• Remove pre-release for release branches on gzdev (example)
  • Stop using prereleases and nightlies for Ionic gzdev#90

Status tracker

Repo	Version	Release Branch	Feature frozen	Synced with previous versions?	Prerelease?	Code Frozen	Stable release?	Open PRs	Pending dep release
gz-cmake		gz-cmake4	✅	✅	✅	✅		PRs
gz-tools		gz-tools2	✅	✅	✅	✅	✅	PRs
gz-utils		gz-utils3	✅	✅	✅	✅		PRs
gz-math		gz-math8	✅	✅	✅	✅		PRs
gz-plugin		gz-plugin3	✅	✅	✅	✅		PRs
gz-common		gz-common6	✅	✅	✅	✅		PRs
gz-msgs		gz-msgs11	✅	✅	✅	✅		PRs
sdformat		sdf15	✅	✅	✅	✅		PRs
gz-fuel-tools		gz-fuel-tools10	✅	✅	✅	✅		PRs
gz-physics		gz-physics8	✅	✅	✅	✅		PRs
gz-rendering		gz-rendering9	✅	✅	✅	✅		PRs
gz-transport		gz-transport14	✅	✅	✅	✅		PRs
gz-gui		gz-gui9	✅	✅	✅	✅		PRs
gz-sensors		gz-sensors9	✅	✅	✅	✅		PRs
gz-sim		gz-sim9	✅	✅	✅	✅		PRs
gz-launch		gz-launch8	✅	✅	✅	✅		PRs
gz-ionic		main	✅	✅	✅	✅		PRs
ros_gz		rolling	✅	✅	✅	✅		PRs

Track stable release of metapackage gz-ionic.

• ⌛ TODO
• 🟡 waiting in the buildfarm
• 🟢 in the repo
• 🔴 requires action
• ⚫ no release

Linux

• Ubuntu:
  • 🟢 Noble/amd64
  • 🟢 Noble/arm64

MacOSX

• Brew
  • 🟢 Ionic Release osrf/homebrew-simulation#2827

Windows

• Conda-forge (community effort)
  • 🟢 https://anaconda.org/conda-forge/gz-sim9

[azeey]

For maintainers, here's the list of steps to create a stable branch for each library that doesn't already have one for the release. (Note, please monitor this post as the steps might need to be updated)

• <library name>:
  • Create a changelog PR (example)
  • New branch button on branches page (example). Make sure to set the Source to main.
  • Enable CI for stable branches (example):
  • Update gazebodistro [(example)[https://github.com/Use stable branch for gz-cmake4 gazebodistro#165])). Use script to update all dependencies:
  • Update homebrew (example)):
  • Run the Jenkins DSL generation job
  • Create a small PR targetting the stable branch. This could be used to update build status badges (example). Don't skip this; it is important for the next step:
  • Update branch protections. Remember to include the abi-checker.
  • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows

[jennuine]

• gz-gui:
  • Create a changelog PR (Ionic Changelog gazebosim/gz-cmake#444)
  • New branch button on branches page (example). Make sure to set the Source to main.
  • Enable CI for stable branches (Use stable branch for gz-cmake4 #1164):
  • Update gazebodistro [(example)[https://github.com/https://github.com/Use stable branch for gz-cmake4 gazebodistro#165])). Use script to update all dependencies:
  • Update homebrew gz-cmake4: use stable branch in url osrf/homebrew-simulation#2730):
  • Run the Jenkins DSL generation job
  • Create a small PR targetting the stable branch. This could be used to update build status badges (Update gz-cmake4 badge URLs gazebosim/gz-cmake#445). Don't skip this; it is important for the next step:
  • Update branch protections. Remember to include the abi-checker.
  • Make a pre-release. Skip merging the homebrew PR. We want to keep formulas building from source until code freeze to match Ubuntu nightlies and windows

[traversaro]

Windows

* **Conda-forge** (community effort)
  
  *

The gz-sim9 and gz-launch8 is now available on conda-forge, and according to my preliminary tests they are working fine (at least without any additional regression on top of known Windows issues).

[azeey]

Awesome. Thanks @traversaro!!

[scpeters]

I opened the following ticket to remind us to add the new SDFormat spec version to http://sdformat.org/spec

• https://github.com/osrf/sdf_web_app/issues/76

we should consider adding this to the collection release issue template as well