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

• [x] Bump major version of libraries early in the development cycle (use bump_libraries template).
• [x] 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

• [x] Merge each library forward from previous versions

• [x] Create stable branches off of main

  • [x] gz-cmake:
  • [x] Create a changelog PR (example): https://github.com/gazebosim/gz-cmake/pull/444
  • [x] New branch button on branches page (example). Make sure to set the Source to main.
  • [x] Enable CI for stable branches : https://github.com/gazebo-tooling/release-tools/pull/1164
  • [x] Update gazebodistro: https://github.com/gazebo-tooling/gazebodistro/pull/165
  • [x] Update homebrew: https://github.com/osrf/homebrew-simulation/pull/2730
  • [x] Run the Jenkins DSL generation job
  • [x] 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: https://github.com/gazebosim/gz-cmake/pull/445
  • [x] Update branch protections. Remember to include the abi-checker.
  • [x] 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.
  • [x] gz-utils:
    • [x] Create a changelog PR (example): https://github.com/gazebosim/gz-utils/pull/136
    • [x] New branch button on branches page (example). Make sure to set the Source to main.
    • [x] Enable CI for stable branches : https://github.com/gazebo-tooling/release-tools/pull/1166
    • [x] Update gazebodistro: https://github.com/gazebo-tooling/gazebodistro/pull/167
    • [x] Update homebrew: https://github.com/osrf/homebrew-simulation/pull/2733
    • [x] Run the Jenkins DSL generation job
    • [x] 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: https://github.com/gazebosim/gz-utils/pull/138
    • [x] Update branch protections. Remember to include the abi-checker.
    • [x] 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
  • [x] gz-math:
    • [x] Create a changelog PR (example): https://github.com/gazebosim/gz-math/pull/618
    • [x] New branch button on branches page (example). Make sure to set the Source to main.
    • [x] Enable CI for stable branches : https://github.com/gazebo-tooling/release-tools/pull/1167
    • [x] Update gazebodistro: https://github.com/gazebo-tooling/gazebodistro/pull/168
    • [x] Update homebrew: https://github.com/osrf/homebrew-simulation/pull/2735
    • [x] Run the Jenkins DSL generation job https://build.osrfoundation.org/job/_dsl_generate_all_dsls/1050/
    • [x] 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: https://github.com/gazebosim/gz-math/pull/622
    • [x] Update branch protections. Remember to include the abi-checker.
    • [x] 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
  • [x] sdformat:
    • [x] Create a changelog PR (example): https://github.com/gazebosim/sdformat/pull/1471
    • [x] New branch button on branches page (example). Make sure to set the Source to main.
    • [x] Enable CI for stable branches: https://github.com/gazebo-tooling/release-tools/pull/1171
    • [x] Update gazebodistro: https://github.com/gazebo-tooling/gazebodistro/pull/172
    • [x] Update homebrew: https://github.com/osrf/homebrew-simulation/pull/2741
    • [x] Run the Jenkins DSL generation job
    • [x] 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: https://github.com/gazebosim/sdformat/pull/1472
    • [X] Update branch protections. Remember to include the abi-checker.
    • [x] 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 https://github.com/gazebosim/sdformat/pull/1473
  • [x] gz-physics:
    • [x] Create a changelog PR (example): https://github.com/gazebosim/gz-physics/pull/678
    • [X] New branch button on branches page (example). Make sure to set the Source to main.
    • [x] Enable CI for stable branches: https://github.com/gazebo-tooling/release-tools/pull/1178
    • [x] Update gazebodistro: https://github.com/gazebo-tooling/gazebodistro/pull/177
    • [x] Update homebrew: https://github.com/osrf/homebrew-simulation/pull/2754
    • [x] Run the Jenkins DSL generation job
    • [x] 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: https://github.com/gazebosim/gz-physics/pull/679
    • [x] Update branch protections. Remember to include the abi-checker.
    • [x] 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
  • [x] gz-msgs:
    • [x] Create a changelog PR (example): https://github.com/gazebosim/gz-msgs/pull/453
    • [x] New branch button on branches page (example). Make sure to set the Source to main.
    • [x] Enable CI for stable branches: https://github.com/gazebo-tooling/release-tools/pull/1172
    • [x] Update gazebodistro: https://github.com/gazebo-tooling/gazebodistro/pull/173
    • [x] Update homebrew: https://github.com/osrf/homebrew-simulation/pull/2743
    • [x] Run the Jenkins DSL generation job
    • [x] 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: https://github.com/gazebosim/gz-msgs/pull/455
    • [x] Update branch protections. Remember to include the abi-checker.
    • [x] 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
  • [x] gz-transport:
    • [x] Create a changelog PR (example): https://github.com/gazebosim/gz-transport/pull/523
    • [x] New branch button on branches page (example). Make sure to set the Source to main.
    • [x] Enable CI for stable branches: https://github.com/gazebo-tooling/release-tools/pull/1173
    • [x] Update gazebodistro: https://github.com/gazebo-tooling/gazebodistro/pull/174
    • [x] Update homebrew: https://github.com/osrf/homebrew-simulation/pull/2744
    • [x] Run the Jenkins DSL generation job
    • [x] 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: https://github.com/gazebosim/gz-transport/pull/524
    • [x] Update branch protections. Remember to include the abi-checker.
    • [x] 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
  • [x] gz-plugin:
    • [x] Create a changelog PR (example): https://github.com/gazebosim/gz-plugin/pull/147
    • [x] New branch button on branches page (example). Make sure to set the Source to main.
    • [x] Enable CI for stable branches: https://github.com/gazebo-tooling/release-tools/pull/1176
    • [x] Update gazebodistro: https://github.com/gazebo-tooling/gazebodistro/pull/176
    • [x] Update homebrew: https://github.com/osrf/homebrew-simulation/pull/2749
    • [x] Run the Jenkins DSL generation job
    • [x] 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: https://github.com/gazebosim/gz-plugin/pull/148
    • [x] Update branch protections. Remember to include the abi-checker.
    • [x] 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
  • [x] gz-fuel-tools:
    • [x] Create a changelog PR (example): https://github.com/gazebosim/gz-fuel-tools/pull/438
    • [x] New branch button on branches page (example). Make sure to set the Source to main.
    • [x] Enable CI for stable branches: https://github.com/gazebo-tooling/release-tools/pull/1174
    • [x] Update gazebodistro: https://github.com/gazebo-tooling/gazebodistro/pull/175
    • [x] Update homebrew: https://github.com/osrf/homebrew-simulation/pull/2746
    • [x] Run the Jenkins DSL generation job
    • [x] 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: https://github.com/gazebosim/gz-fuel-tools/pull/439
    • [x] Update branch protections. Remember to include the abi-checker.
    • [x] 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
  • [x] gz-rendering:
    • [x] Create a changelog PR (example): https://github.com/gazebosim/gz-rendering/pull/1042
    • [x] New branch button on branches page (example). Make sure to set the Source to main.
    • [x] Enable CI for stable branches: https://github.com/gazebo-tooling/release-tools/pull/1168
    • [x] Update gazebodistro: https://github.com/gazebo-tooling/gazebodistro/pull/169
    • [x] Update homebrew: https://github.com/osrf/homebrew-simulation/pull/2736
    • [x] Run the Jenkins DSL generation job
    • [x] 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: https://github.com/gazebosim/gz-rendering/pull/1044
    • [x] Update branch protections. Remember to include the abi-checker.
    • [x] 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
  • [x] gz-sensors:
    • [x] Create a changelog PR (example): https://github.com/gazebosim/gz-sensors/pull/459
    • [x] New branch button on branches page (example). Make sure to set the Source to main.
    • [x] Enable CI for stable branches: https://github.com/gazebo-tooling/release-tools/pull/1170
    • [x] Update gazebodistro: https://github.com/gazebo-tooling/gazebodistro/pull/171
    • [x] Update homebrew: https://github.com/osrf/homebrew-simulation/pull/2739
    • [x] Run the Jenkins DSL generation job
    • [x] 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: https://github.com/gazebosim/gz-sensors/pull/463
    • [x] Update branch protections. Remember to include the abi-checker.
    • [x] 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
  • [x] gz-sim:
    • [x] Create a changelog PR (example): https://github.com/gazebosim/gz-sim/pull/2554
    • [x] New branch button on branches page (example). Make sure to set the Source to main.
    • [x] Enable CI for stable branches: https://github.com/gazebo-tooling/release-tools/pull/1181
    • [x] Update gazebodistro: https://github.com/gazebo-tooling/gazebodistro/pull/180
    • [x] Update homebrew: https://github.com/osrf/homebrew-simulation/pull/2763
    • [x] Run the Jenkins DSL generation job
    • [x] 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: https://github.com/gazebosim/gz-sim/pull/2554
    • [x] Update branch protections. Remember to include the abi-checker.
    • [x] 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
  • [x] gz-launch:
    • [x] Create a changelog PR (example): https://github.com/gazebosim/gz-launch/pull/273
    • [x] New branch button on branches page (example). Make sure to set the Source to main.
    • [x] Enable CI for stable branches: https://github.com/gazebo-tooling/release-tools/pull/1180
    • [x] Update gazebodistro: https://github.com/gazebo-tooling/gazebodistro/pull/179
    • [x] Update homebrew: https://github.com/osrf/homebrew-simulation/pull/2762
    • [x] Run the Jenkins DSL generation job
    • [x] 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: https://github.com/gazebosim/gz-launch/pull/273
    • [x] Update branch protections. Remember to include the abi-checker.
    • [x] 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

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

  • [x] https://github.com/gazebosim/gz-cmake/pull/444
  • [x] gz-utils
  • [x] https://github.com/gazebosim/gz-math/pull/618

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

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

Code freeze

• [x] Choose name for next release.
  • https://community.gazebosim.org/t/name-the-next-gazebo-release-gazebo-j/3020/1
• [x] Start T-Shirt campaign
  • https://ignition-gazebo.creator-spring.com/
• [x] Update all repositories to default to the new stable branches.
• [x] 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
  • [x] ROS2 Installation https://github.com/gazebosim/docs/blob/master/ros_installation.md https://github.com/gazebosim/docs/pull/502
  • [ ] ros_gz README https://github.com/gazebosim/ros_gz/blob/ros2/README.md
• [x] PRs fixing documentation and critical bugs can be merged and pre-released
• As libraries have all their documentation reviewed:
  • [x] #1184

Release day

• [x] Make collection stable release after all libraries are released.
  • https://github.com/gazebosim/gz-ionic/pull/10
  • https://github.com/gazebo-tooling/gzdev/pull/90/files
• [ ] Make GitHub releases for all the X.0.0 versions (example)
• [x] Update docs to say release is stable (example)
  • https://github.com/gazebosim/docs/pull/520
• [x] 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)
  • [x] Source code (example)
    • [x] gz-cmake 5.0.0~pre1
    • [x] gz-common 7.0.0~pre1
    • [x] gz-fuel-tools 11.0.0~pre1
    • [x] gz-sim 10.0.0~pre1
    • [x] gz-gui 10.0.0~pre1
    • [x] gz-launch 9.0.0~pre1
    • [x] gz-math 9.0.0~pre1
    • [x] gz-msgs 12.0.0~pre1
    • [x] gz-physics 9.0.0~pre1
    • [x] gz-plugin 4.0.0~pre1
    • [x] gz-rendering 10.0.0~pre1
    • [x] gz-sensors 10.0.0~pre1
    • [x] gz-tools 3.0.0~pre1
    • [x] gz-transport 15.0.0~pre1
    • [x] gz-utils 4.0.0~pre1
    • [x] sdformat 16.0.0~pre1
  • [x] Add files to gazebodistro (example)
    • https://github.com/gazebo-tooling/gazebodistro/pull/182
  • [x] Add aliases to homebrew-simulation (example)
    • https://github.com/osrf/homebrew-simulation/pull/2833
  • [x] Create new -release repositories (use this script)
  • [x] Enable nightlies for all main branches on gzdev (example)
    • https://github.com/gazebo-tooling/gzdev/pull/91
  • [ ] Execute the tick-tock's "tock" for deprecations (example)
• [x] Enable Jenkins CI for new stable branches (example)
  • https://github.com/gazebo-tooling/release-tools/pull/1188
• [x] Remove pre-release for release branches on gzdev (example)
  • https://github.com/gazebo-tooling/gzdev/pull/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.

• :hourglass: TODO
• :yellow_circle: waiting in the buildfarm
• :green_circle: in the repo
• :red_circle: requires action
• :black_circle: no release

Linux

• Ubuntu:
  • [x] :green_circle: Noble/amd64
  • [x] :green_circle: Noble/arm64

MacOSX

• Brew
  • [x] :green_circle: https://github.com/osrf/homebrew-simulation/pull/2827

Windows

• Conda-forge (community effort)
  • [x] :green_circle: 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/gazebo-tooling/gazebodistro/pull/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]

• [x] gz-gui:
  • [x] Create a changelog PR (https://github.com/gazebosim/gz-cmake/pull/444)
  • [x] New branch button on branches page (example). Make sure to set the Source to main.
  • [x] Enable CI for stable branches (https://github.com/gazebo-tooling/release-tools/pull/1164):
  • [x] Update gazebodistro [(example)[https://github.com/https://github.com/gazebo-tooling/gazebodistro/pull/165])). Use script to update all dependencies:
  • [x] Update homebrew https://github.com/osrf/homebrew-simulation/pull/2730):
  • [x] Run the Jenkins DSL generation job
  • [x] Create a small PR targetting the stable branch. This could be used to update build status badges (https://github.com/gazebosim/gz-cmake/pull/445). Don't skip this; it is important for the next step:
  • [x] Update branch protections. Remember to include the abi-checker.
  • [x] 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

[azeey]

For reference, here's the topological list of packages by dependency. This is generated from colcon list -tn

• gz-cmake4
• gz-tools2
• gz-utils3
• gz-math8
• gz-plugin3
• gz-common6
• gz-msgs11
• sdformat15
• gz-fuel_tools10
• gz-physics8
• gz-rendering9
• gz-transport14
• gz-gui9
• gz-sensors9
• gz-sim9
• gz-launch8

The order is not strict. For example, sdformat is listed after gz-msgs, but it does not depend on gz-msgs, so it could be released before it. The graph generated by colcon graph is more informative in this respect

gz-cmake4        +***********.***
gz-tools2         +  * ***..*****
gz-utils3          +***.******.*.
gz-math8            + ***********
gz-plugin3           +    ** *.**
gz-common6            +  *** ****
gz-msgs11              + *  *****
sdformat15              + *   **.
gz-fuel_tools10          +     *.
gz-physics8               +    *.
gz-rendering9              + ***.
gz-transport14              +****
gz-gui9                      + **
gz-sensors9                   +*.
gz-sim9                        +*
gz-launch8                      +

which shows that sdformat can be released right after gz-math.

[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