Release Garden

[chapulina]

Timeline

Current tentative timeline

• Feature freeze: 2022/07/29 (Friday)
• Code freeze: 2022/08/31 (Wednesday)
• Tutorial party: 2022/09/01 (Thu) ~ 2022/09/16 (Fri)
• Internal QA: 2022/09/19 (Mon) ~ 2022/09/23 (Fri)
• Community meeting: 2022/09/28 (Wednesday)
• Announcement: 2022/10/03 (Monday)

During development

• Bump major version of libraries early in the development cycle (use bump_libraries template).
• Work with artist on logo.

Feature freeze

• Choose name for next release.
• Merge each library forward from previous versions
  • gz-cmake
  • gz-common
  • gz-fuel-tools (there are open bug fixes that need to be ported by code freeze)
  • gz-sim
    • Merge ign-gazebo3 ➡️ ign-gazebo6 gazebosim/gz-sim#1626
    • Merge ign-gazebo6 ➡️ main (part 1) gazebosim/gz-sim#1630
    • Merge ign-gazebo6 ➡️ main (part 2) gazebosim/gz-sim#1631
    • Merge ign-gazebo6 ➡️ main (part 3/3) gazebosim/gz-sim#1633
  • gz-gui - Merge ign-gui6 ➡️ main gazebosim/gz-gui#446
  • gz-launch - Merge ign-launch5 ➡️ main gazebosim/gz-launch#186
  • gz-math
  • gz-msgs - Merge ign-msgs8 ➡️ main gazebosim/gz-msgs#289
  • gz-physics - Merge ign-physics5 ➡️ main gazebosim/gz-physics#398
  • gz-plugin - Merge ign-plugin1 ➡️ main gazebosim/gz-plugin#98
  • gz-rendering
  • gz-sensors
    • Merge ign-sensors3 ➡️ ign-sensors6 gazebosim/gz-sensors#252
    • Merge ign-sensors6 ➡️ main gazebosim/gz-sensors#247
  • gz-tools
  • gz-transport - Merge ign-transport11 ➡️ main gazebosim/gz-transport#343
  • gz-utils - Merge ign-utils1 ➡️ main gazebosim/gz-utils#75
  • sdformat - Merge sdf12 ➡️ main gazebosim/sdformat#1103
• Create stable branches off of main
  • Make sure the new branches are covered by branch protection
  • gz-cmake3
  • gz-tools2
  • gz-common5
  • gz-fuel-tools8
  • gz-sim7
  • gz-gui7
  • gz-launch6
  • gz-math7
  • gz-msgs9
  • gz-physics6
  • gz-plugin2
  • gz-rendering7
  • gz-sensors7
  • gz-transport12
  • gz-utils2
  • sdf13
• 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)
    • ⬆️ Bump main to 4.0.0~pre1 gazebosim/gz-cmake#296
    • ⬆️ Bump main to 3.0.0~pre1 gazebosim/gz-tools#102
    • ⬆️ Bump main to 6.0.0~pre1 gazebosim/gz-common#412
    • ⬆️ Bump main to 9.0.0~pre1 gazebosim/gz-fuel-tools#283
    • ⬆️ Bump main to 8.0.0~pre1 gazebosim/gz-sim#1640
    • ⬆️ Bump main to 8.0.0~pre1 gazebosim/gz-gui#456
    • ⬆️ Bump main to 7.0.0~pre1 gazebosim/gz-launch#189
    • ⬆️ Bump main to 8.0.0~pre1 gazebosim/gz-math#478
    • ⬆️ Bump main to 10.0.0~pre1 gazebosim/gz-msgs#292
    • ⬆️ Bump main to 7.0.0~pre1 gazebosim/gz-physics#399
    • ⬆️ Bump main to 3.0.0~pre1 gazebosim/gz-plugin#99
    • ⬆️ Bump main to 8.0.0~pre1 gazebosim/gz-rendering#699
    • ⬆️ Bump main to 8.0.0~pre1 gazebosim/gz-sensors#254
    • ⬆️ Bump main to 13.0.0~pre1 gazebosim/gz-transport#344
    • ⬆️ Bump main to 3.0.0~pre1 gazebosim/gz-utils#76
    • ⬆️ Bump main to 14.0.0~pre1 gazebosim/sdformat#1104
  • Add files to gazebodistro (example)
    • Add gz-cmake4, update cmake3 gazebodistro#116
    • Add gz-tools3, update tools2 gazebodistro#115
    • Update Garden branches, create post-Garden files gazebodistro#119
    • Add gz-sim8, update gz-sim7 gazebodistro#120
  • Add aliases to homebrew-simulation (example)
    • Add aliases for versions post-Garden osrf/homebrew-simulation#1981
    • Use Garden stable branches osrf/homebrew-simulation#1985
    • Missing post-Garden alias: sdformat14 osrf/homebrew-simulation#1986
    • Update gz-sim7 branch osrf/homebrew-simulation#1988
  • Create new -release repositories (use this script)
  • Enable nightlies for all main branches on gzdev (example)
    • Enable nightlies for new main branches gzdev#62
  • Build nightlies from new stable branches
    • nightlies: build from release branches #785
    • Build nightlies from gz-sim7 branch #790
  • Execute the tick-tock's "tock" for deprecations (example)
• Pre-release libraries as all beta labels are merged.
  • gz-cmake3
  • gz-tools2
  • gz-common5
  • gz-fuel-tools8
  • gz-sim7
  • gz-gui7
  • gz-launch6
  • gz-math7
  • gz-msgs9
  • gz-physics6
  • gz-plugin2
  • gz-rendering7
  • gz-sensors7
  • gz-transport12
  • gz-utils2
  • sdf13
• Make collection pre-release after all libraries are pre-released.
• Update public documentation to install from pre-releases instead of nightlies.
  • Pre-release binaries for Garden gazebosim/docs#292

Code freeze

• Start T-Shirt campaign
  • https://community.gazebosim.org/t/gazebo-garden-tshirts-available/1575
• Hold tutorial party (example)
• PRs fixing documentation and critical bugs can be merged and pre-released
• Library changelogs
  • gz-cmake3 Changelog: update for 3.0.0 gazebosim/gz-cmake#310
  • gz-tools2 Update Changelog for 2.0.0 gazebosim/gz-tools#112
  • gz-common5 Update changelogs for common 5.0.0 gazebosim/gz-common#443
  • gz-fuel-tools8 8 0 0 release gazebosim/gz-fuel-tools#301
  • gz-gui7 Update changelog for 7.0.0 gazebosim/gz-gui#492
  • gz-launch6 Update changelog for 6.0.0 gazebosim/gz-launch#201
  • gz-math7 Update Changelog for 7.0.0 gazebosim/gz-math#506
  • gz-msgs9 Update Changelog for 9.0.0 gazebosim/gz-msgs#305
  • gz-physics6 Update Changelog for 6.0.0 gazebosim/gz-physics#427
  • gz-plugin2 2.0.0 release gazebosim/gz-plugin#107
  • gz-rendering7 Update Changelog for 7.0.0 gazebosim/gz-rendering#728
  • gz-sensors7 Update Changelog for 7.0.0 gazebosim/gz-sensors#274
  • gz-sim7 Update changelogs for sim 7.0.0 gazebosim/gz-sim#1729
  • gz-transport12 Update Changelog for 12.0.0 gazebosim/gz-transport#361
  • gz-utils2 Update changelog gazebosim/gz-utils#79
  • sdf13 Update Changelog for 13.0.0 gazebosim/sdformat#1139
• Make stable releases
  • gz-cmake3
  • gz-tools2
  • gz-common5
  • gz-fuel-tools8
  • gz-gui7
    • Fix arm releases.
  • gz-launch6
  • gz-math7
  • gz-msgs9
  • gz-physics6
    • Fix arm releases.
  • gz-plugin2
  • gz-rendering7
    • Fix arm releases.
  • gz-sensors7
    • Fix arm releases.
  • gz-sim7
  • gz-transport12
  • gz-utils2
  • sdf13

Release day

• Make collection stable release after all libraries are released.
• Update gazebodistro (example)
• Make GitHub releases for all the X.0.0 versions (example)
• Update docs to say release is stable (example)
• Make announcement

Post-release

• Enable Jenkins CI for new stable branches (example)
• Remove nightlies for release branches on gzdev (example) Use stable repository only for Garden gzdev#64
• Update all repositories to default to the new stable branches.

If the collection will be officially paired with a ROS 2 distro:

• Update REP-2000 when ROS 2 distro is added (example)
• Import stable releases into https://packages.ros.org (example)
• Add new rosdep keys (example)
• Bloom-release ros_ign with the new version into Rolling before fork (example)

Status tracker

Track stable release of metapackage gz-<collection>.

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

Linux

• Ubuntu:

  • 🟢 : Focal/amd64
  • 🟢 Jammy/amd64
  • 🟢 : Focal/arm64
  • 🟢 Focal/armhf
  • 🟢 Jammy/arm64
  • 🔴 Jammy/armhf
    • Blocked by ogre-next-2.3 fails to compile

• Debian:

  • ⚫ None in this release.

macOS

• Brew
  • 🟢 Bottles BigSur
  • 🟢 Bottles Carolina

Windows

⚠️ Please note that gz Garden on Windows is not fully functional and won't work out of the box. Please read the open issue for Windows support for more information.

• Conda-forge (community effort)
  • 🟢 Ignition Garden renamed to Gazebo Garden conda-forge/libignition-cmake0-feedstock#26 (thanks mainly to @traversaro)

[scpeters]

our nightly builds are still set to build from main, and bumping the major version numbers on main has broken some nightly builds:

https://build.osrfoundation.org/view/ign-garden/job/ign-math7-debbuilder/802/

I propose updating the nightly builds to use release branches: #785

[scpeters]

our nightly builds are still set to build from main, and bumping the major version numbers on main has broken some nightly builds:

https://build.osrfoundation.org/view/ign-garden/job/ign-math7-debbuilder/802/

I propose updating the nightly builds to use release branches: #785

we'll also need to update the branches in the unreleased homebrew formulae and in gzdev (gzdev is based on cmake project name, not branch name, so it doesn't need any changes)

[chapulina]

we'll also need to update the branches in the unreleased homebrew formulae and in gzdev (gzdev is based on cmake project name, not branch name, so it doesn't need any changes)

• Use Garden stable branches osrf/homebrew-simulation#1985
• Enable nightlies for new main branches gzdev#62

[scpeters]

the gz-gui7 and gz-sim7 debbuilder jobs are still unstable. I think gazebo-release/gz-sim7-release#15 will fix gz-sim7, but I don't see a PR yet to fix gz-gui7-release

[azeey]

the gz-gui7 and gz-sim7 debbuilder jobs are still unstable. I think gazebo-release/gz-sim7-release#15 will fix gz-sim7, but I don't see a PR yet to fix gz-gui7-release

gazebo-release/gz-gui7-release#13

[scpeters]

gz-tools 2.0.0 Jammy arm64 debbuild failed: gazebosim/gz-tools#114