Release Harmonic

[azeey]

Timeline

Current timeline

• Feature freeze: 2023/07/28 (Friday)
• Code freeze: 2023/08/30 (Wednesday)
• Tutorial party: 2023/08/31 (Thu) ~ 2023/09/15 (Fri)
• Internal QA: 2023/09/18 (Mon) - 2023/09/22 (Fri)
• Community meeting: 2023/09/27 (Wednesday)
• Announcement: 2023/10/02 (Monday)

During development

• Bump major version of libraries early in the development cycle (use bump_libraries template).
  • Bump in Harmonic: sdformat, gz-physics  #976
  • Bump in Harmonic: gz-msgs and gz-transport #878
  • Bump in Harmonic: gz-rendering and dependents #853
• Work with artist on logo.

Feature freeze

• Choose name for next release.

  • https://community.gazebosim.org/t/name-the-next-gazebo-release-gazebo-i/2199

• Merge each library forward from previous versions

• Create stable branches off of main

• gz-msgs

  • New branch button on branches page (example)
  • Enable CI for stable branches (example)
  • Use stable branch jobs in Jenkins view (example part 1 and part 2)
  • Update gazebodistro (example)

• sdformat

  • New branch button on branches page (example)
  • Enable CI for stable branches (example)
  • Use stable branch jobs in Jenkins view (example part 1 and part 2)
  • Update gazebodistro (example)

• gz-rendering

  • New branch button on branches page (example)
  • Enable CI for stable branches (example)
  • Use stable branch jobs in Jenkins view (example part 1 and part 2)
  • Update gazebodistro (example)

• gz-fuel-tools

  • New branch button on branches page (example)
  • Enable CI for stable branches (example)
  • Use stable branch jobs in Jenkins view (example part 1 and part 2)
  • Update gazebodistro (example)

• gz-transport

  • New branch button on branches page (example)
  • Enable CI for stable branches (example)
  • Use stable branch jobs in Jenkins view (example part 1 and part 2)
  • Update gazebodistro (example)

• gz-sensors

  • New branch button on branches page (example)
  • Enable CI for stable branches (example)
  • Use stable branch jobs in Jenkins view (example part 1 and part 2)
  • Update gazebodistro (example)

• gz-gui

  • New branch button on branches page (example)
  • Enable CI for stable branches (example)
  • Use stable branch jobs in Jenkins view (example part 1 and part 2)
  • Update gazebodistro (example)

• gz-physics

  • New branch button on branches page (example)
  • Enable CI for stable branches (example)
  • Use stable branch jobs in Jenkins view (example part 1 and part 2)
  • Update gazebodistro (example)

• gz-sim

  • New branch button on branches page (example)
  • Enable CI for stable branches (example)
  • Use stable branch jobs in Jenkins view (example part 1 and part 2)
  • Update gazebodistro (example)

• gz-launch

  • New branch button on branches page (example)
  • Enable CI for stable branches (example)
  • Use stable branch jobs in Jenkins view (example part 1 and part 2)
  • Update gazebodistro (example)

• 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)

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

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

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

• Change nightlies to pre-release for release branches on gzdev (example)

Code freeze

• Start T-Shirt campaign
  • https://community.gazebosim.org/t/gazebo-harmonic-tshirts-available/2291
• Hold tutorial party (example)
  • https://community.gazebosim.org/t/gazebo-harmonic-tutorial-party-support-open-source-and-get-t-shirts/2238
• 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
  • 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 stable releases
• Review branch protections for new stable branches.

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

Bumping main versions will happen as part of Ionic since we're bumping all major versions for that release.

Status tracker

Repo	Version	Release Branch	Feature frozen	Synced with previous versions?	Prerelease?	Code Frozen	Stable release?	Open PRs	Pending dep release
gz-tools	2.0.0	gz-tools2	✔️	✔️	✔️	✔️	✔️	PRs
gz-cmake	3.4.1	gz-cmake3	✔️	✔️	✔️	✔️	✔️	PRs
gz-math	7.3.0	gz-math7	✔️		✔️	✔️	✔️	PRs
gz-plugin	2.0.2	gz-plugin2	✔️	✔️	✔️	✔️	✔️	PRs
gz-utils	2.1.0	gz-utils2	✔️	✔️	✔️	✔️	✔️	PRs
gz-common	5.4.2	gz-common5	✔️	✔️	✔️	✔️	✔️	PRs
gz-msgs	10.0.0	gz-msgs10	✔️	✔️	✔️	✔️	✔️	PRs
gz-rendering	8.0.0	gz-rendering8	✔️	✔️	✔️	✔️	✔️	PRs
sdformat	14.0.0	sdf14	✔️	✔️	✔️	✔️	✔️	PRs
gz-fuel-tools	9.0.0	gz-fuel-tools9	✔️	✔️	✔️	✔️	✔️	PRs
gz-transport	13.0.0	gz-transport13	✔️	✔️	✔️	✔️	✔️	PRs
gz-gui	8.0.0	gz-gui8	✔️	✔️	✔️	✔️	✔️	PRs
gz-sensors	8.0.0	gz-sensors8	✔️	✔️	✔️	✔️	✔️	PRs
gz-physics	7.0.0	gz-physics7	✔️	✔️	✔️	✔️	✔️	PRs
gz-sim	8.0.0	gz-sim8	✔️	✔️	✔️	✔️	✔️	PRs
gz-launch	7.0.0	gz-launch7	✔️	✔️	✔️	✔️	✔️	PRs
gz-harmonic	1.0.0	main	✔️	✔️	✔️	✔️	✔️	PRs
ros_gz		iron, rolling	✔️	✔️	✔️	✔️	✔️	PRs

Track stable release of metapackage gz-harmonic.

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

Linux

• Ubuntu:
  • 🟢 Jammy/amd64
  • 🟢 Jammy/arm64

MacOSX

• Brew
  • 🟢 Bottles

Windows

• Conda-forge (community effort)
  • ⌛

[scpeters]

per #928, should we remove the focal/debian folders from all the packages that will exclusively be on Harmonic? For example:

• https://github.com/gazebo-release/gz-sensors8-release/tree/main/focal/debian

[azeey]

per #928, should we remove the focal/debian folders from all the packages that will exclusively be on Harmonic? For example:

• https://github.com/gazebo-release/gz-sensors8-release/tree/main/focal/debian

I believe all focal directories have been removed from release repos of Harmonic-only packages.