Release Fortress

[chapulina]

Timeline

Current tentative timeline

• Feature freeze: 2021/09/07 (Tuesday)
• Code freeze: 2021/09/21 (Tuesday)
• Tutorial party: 2021/09/22 - 2021/09/29
• Community meeting: 2021/09/29 (Wednesday)
• Release: 2021/09/30 (Thursday)

During development

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

Feature freeze

• Choose name for next release.
• Merge each library forward from previous versions
  • 3 ➡️ 4 gazebosim/gz-sensors#153
  • 6 ➡️ 7 (main) gazebosim/gz-fuel-tools#201
  • 4 ➡️ 5 gazebosim/gz-sim#1007
  • 11 ➡️ main gazebosim/sdformat#693
  • 3 ➡️ 4 gazebosim/gz-sim#1017
  • 3 ➡️ 4  gazebosim/gz-rendering#398
  • 3 ➡️ 4 gazebosim/gz-gui#279
  • 2 ➡️ 3 gazebosim/gz-physics#290
  • 3 ➡️ 4 gazebosim/gz-common#246
  • 4 ➡️ 5 gazebosim/gz-gui#280
  • 4 ➡️ 5 gazebosim/gz-rendering#399
  • 5 ➡️ 6 (main) gazebosim/gz-rendering#401
  • 5 ➡️ 6 (main) gazebosim/gz-sim#1020
  • 3 ➡️ 4 gazebosim/gz-physics#291
  • 5 ➡️ 6 (main) gazebosim/gz-gui#281
  • 6 ➡️ 7 gazebosim/gz-msgs#180
  • 9 ➡️ 10 gazebosim/gz-transport#259
  • 4 ➡️ 5 (main) gazebosim/gz-physics#292
  • 4 ➡️ 5 gazebosim/gz-sensors#154
  • 7 ➡️ 8 (main) gazebosim/gz-msgs#182
  • 10 ➡️ 11 (main) gazebosim/gz-transport#260
  • 5 ➡️ 6 (main) gazebosim/gz-sensors#155
• Label pull requests being considered to enter release with beta
  Pull requests opened against the new collection after then:
  • Bug fixes: will be considered for the initial release and labeled beta
  • New features: will not be considered for the initial release.
• Pre-release libraries as all beta labels are merged.
  • 🎈 1.3.0~pre1 gazebosim/gz-tools#60
  • 🎈 1.2.1~pre1 gazebosim/gz-plugin#60
  • 🎈 8.0.0~pre1 gazebosim/gz-msgs#183
  • 🎈 7.0.0~pre1 gazebosim/gz-fuel-tools#205
  • ign-transport 10.0.0~pre1
  • libsdformat 12.0.0~pre1
  • Prepare for 6.0.0 pre1 release gazebosim/gz-rendering#417
  • Prepare for 5.0.0~pre1 gazebosim/gz-physics#293
  • 🎈 6.0.0~pre1 gazebosim/gz-gui#288
  • 🎈 6.9.0~pre1 gazebosim/gz-math#245
  • 🎈 4.3.0~pre1 gazebosim/gz-common#251
  • 🎈 6.0.0~pre2 gazebosim/gz-rendering#421
  • 6.0.0~pre1 gazebosim/gz-sensors#159
  • ign-gazebo 6.0.0~pre1
  • ign-launch 5.0.0~pre1
• Make collection pre-release after all libraries are pre-released.
• Update public documentation to install from pre-releases instead of nightlies.

Code freeze

• Start T-Shirt campaign
• Hold tutorial party (example)
• PRs fixing documentation and critical bugs can be merged and pre-released
• As libraries have all their documentation reviewed:
  • Create stable branches off of main
  • Make stable releases
    • 🎈 1.2.1 gazebosim/gz-plugin#62
    • 🎈 1.3.0 gazebosim/gz-tools#62
    • 🎈 8.0.0 gazebosim/gz-msgs#186
    • 🎈 7.0.0 gazebosim/gz-fuel-tools#208
    • 🎈 11.0.0 gazebosim/gz-transport#266
    • 🎈 6.9.0 gazebosim/gz-math#254
    • 🎈 12.0.0 gazebosim/sdformat#724
    • 🎈 6.0.0 gazebosim/gz-rendering#445
    • 🎈 5.0.0 gazebosim/gz-physics#294
    • Prepare for 6.0.0 release gazebosim/gz-sensors#161
    • 🎈 6.0.0  gazebosim/gz-gui#296
    • 🎈 6.0.0 gazebosim/gz-sim#1079
    • 🎈 5.0.0 gazebosim/gz-launch#133

Release day

• Make collection stable release after all libraries are released.
  • 🎈 1.0.0 gazebosim/gz-fortress#3
• Update gazebodistro (example)
  • Use stable branches for Fortress gazebodistro#46
• Make GitHub releases for all the X.0.0 versions (example)
• Update docs to say release is stable (example)
  • Fortress stable gazebosim/docs#205
• Make announcement: https://community.gazebosim.org/t/ignition-fortress-release/1127

Post-release

• Enable Jenkins CI for new stable branches (example)
  • Fortress stable #531
  • Adding new Fortress branches to ABI checker #523
• Remove nightlies for release branches on gzdev (example)
  • Use pre-releases for Fortress gzdev#35
  • Use stable only for Fortress gzdev#36
• Bump all main branches to the next major version (X.0.0~pre1)
  • Source code (example)
    • Bump main to 9.0.0~pre1 gazebosim/gz-msgs#187
    • Bump main to 12.0.0~pre1 gazebosim/gz-transport#271
    • Bump main to 8.0.0~pre1 gazebosim/gz-fuel-tools#209
    • Bump main to 7.0.0~pre1 gazebosim/gz-rendering#458
    • Bump main to 7.0.0~pre1 gazebosim/gz-sensors#164
    • Bump main to 7.0.0~pre1 gazebosim/gz-gui#301
    • Bump main to 13.0.0~pre1 gazebosim/sdformat#728
    • Bump main to 6.0.0~pre1 gazebosim/gz-physics#296
    • Bump main to 7.0.0~pre1 gazebosim/gz-sim#1094
    • Bump main to 6.0.0~pre1 gazebosim/gz-launch#134
  • Add files to gazebodistro (example)
    • Add files for new main branches gazebodistro#49
  • Add aliases to homebrew-simulation (example)
    • Add aliases for new major versions osrf/homebrew-simulation#1617
  • Create new -release repositories (use this script)
• 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)
  • Add Humble to REP 2000 ros-infrastructure/rep#326
• Import stable releases into https://packages.ros.org (example)
  • Add Ignition Fortress ros-infrastructure/reprepro-updater#128
  • Add Ogre 2.2 (For Ignition Fortress) ros-infrastructure/reprepro-updater#138
• Add new rosdep keys (example)
  • Ignition Fortress rosdep keys ros/rosdistro#31591
• Update ros_ign source to support the new ROS 2 + Ignition combination
  • Default to Fortress gazebosim/ros_gz#185
  • Default to Fortress for Rolling (future Humble) gazebosim/ros_gz#195
• Bloom-release ros_ign with the new version into Rolling before fork (example)
  • ros_ign: 0.244.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#31645
  • Check that release worked in the next sync

Status tracker

Repo	Version	Release Branch	Feature frozen	Synced with C,D&E?	Prerelease?	Code Frozen	Stable release?	Open PRs	Pending dep release
ign-tools	1	ign-tools1	✔️	✔️	✔️	✔️	✔️	PRs	-
ign-cmake	2	ign-cmake2	✔️	✔️	✔️	✔️	✔️	PRs	-
ign-math	6	ign-math6	✔️	✔️	✔️	✔️	✔️	PRs	-
ign-plugin	1	ign-plugin1	✔️	✔️	✔️	✔️	✔️	PRs	-
ign-utils	1	ign-utils1	✔️	✔️	✔️	✔️	✔️	PRs	-
ign-common	4	ign-common4	✔️	✔️	✔️	✔️	✔️	PRs	-
ign-msgs	8	ign-msgs8	✔️	✔️	✔️	✔️	✔️	PRs	-
ign-rendering	6	ign-rendering6	✔️	✔️	✔️	✔️	✔️	PRs	-
sdformat	12	sdf12	✔️	✔️	✔️	✔️	✔️	PRs	-
ign-fuel-tools	7	ign-fuel-tools7	✔️	✔️	✔️	✔️	✔️	PRs	ign-msgs
ign-transport	11	ign-transport11	✔️	✔️	✔️	✔️	✔️	PRs	ign-msgs
ign-gui	6	ign-gui6	✔️	✔️	✔️	✔️	✔️	PRs	ign-transport, ign-rendering
ign-sensors	6	ign-sensors6	✔️	✔️	✔️	✔️	✔️	PRs	ign-transport, ign-rendering
ign-physics	5	ign-physics5	✔️	✔️	✔️	✔️	✔️	PRs	sdformat
ign-gazebo	6	ign-gazebo6	✔️	✔️	✔️	✔️	✔️	PRs	ign-physics, ign-gui, ign-sensors
ign-launch	5	ign-launch5	✔️	✔️	✔️	✔️	✔️	PRs	ign-gazebo
ign-fortress	1	main	✔️	✔️	✔️	✔️	✔️	PRs	ign-launch
ros_ign	noetic / rolling	noetic / ros2	✔️	✔️	✔️			PRs	ign-fortress

Track stable release of metapackage ignition-fortress.

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

Linux

• Ubuntu:

  • 🟢 Bionic/amd64
  • 🟢 Bionic/i386
  • 🟢 Bionic/armhf
  • 🟢 Bionic/arm64
  • 🟢 Focal/amd64
  • 🟢 Focal/arm64
  • 🟢 Focal/armhf

• Debian: (no DART in physics)

  • 🟢 Buster/i386
  • 🟢 Buster/amd64
  • 🟢 Buster/arm64
  • 🟢 Buster/armhf (raspbian)
  • ⚫ Sid/*: (since we are working downstream my plan is to release only the remaining pieces)

MacOSX

• Brew
  • 🟢 Bottles

Windows

• Conda-forge (community effort)
  • ⌛ Release Fortress #459 (comment)

[traversaro]

Windows

conda-forge

(WIP Table, will be updated with more rows as more Fortress packages are released, @chapulina let me know if you like this format or we can do a separate issue or something else). Contains several PRs that are merged by @Tobias-Fischer or @wolfv .

Repo	Related PRs	Fortress-related release available in conda-forge
ign-tools	conda-forge/libignition-tools-feedstock#10	🟢
ign-cmake	None, as there was no ign-cmake release related to Fortress (perhaps the closest candidate is conda-forge/libignition-cmake0-feedstock#18 ?)	🟢
ign-math	conda-forge/libignition-math4-feedstock#18, conda-forge/libignition-math4-feedstock#19, conda-forge/libignition-math4-feedstock#21	🟢
ign-plugin	conda-forge/libignition-plugin-feedstock#14	🟢
ign-utils	conda-forge/libignition-utils-feedstock#6	🟢
ign-common	conda-forge/libignition-common-feedstock#41	🟢
ign-msgs	conda-forge/libignition-msgs1-feedstock#58	🟢
ign-rendering	conda-forge/libignition-rendering4-feedstock#19, conda-forge/libignition-rendering4-feedstock#20, conda-forge/libignition-rendering4-feedstock#24	🟢
sdformat	conda-forge/libsdformat-feedstock#49	🟢
ign-fuel-tools	conda-forge/libignition-fuel-tools-feedstock#48	🟢
ign-transport	conda-forge/libignition-transport4-feedstock#47	🟢
ign-gui	conda-forge/libignition-gui-feedstock#14	🟢
ign-sensors	conda-forge/libignition-sensors-feedstock#16, conda-forge/libignition-sensors-feedstock#17	🟢
ign-physics	conda-forge/libignition-physics-feedstock#21	🟢
ign-gazebo	conda-forge/libignition-gazebo-feedstock#24, conda-forge/libignition-gazebo-feedstock#25	🟢
ign-launch	conda-forge/libignition-launch-feedstock#7, conda-forge/libignition-launch-feedstock#8	🟢

For what regards ign-fortress, we do not have meta packages for ignition releases in conda-forge (even if it would be possible to have them if anyone is interested, see conda-forge/staged-recipes#13551 (comment)). For what regards ros_ign , we should probably deal with this on RoboStack repos, but it does not make sense to do so until we have libign-gazebo6 properly released on conda-forge .

[chapulina]

Thanks for all the work on Windows, @traversaro , that format looks good to me.

Probably not just related to Fortress, but I did notice some feedstocks have version numbers that don't match the major versions in Fortress (msgs1, rendering4, transport4...). Let me know what would be a better place to talk about this.

[traversaro]

Probably not just related to Fortress, but I did notice some feedstocks have version numbers that don't match the major versions in Fortress (msgs1, rendering4, transport4...). Let me know what would be a better place to talk about this.

That is just the name of the repositories, that we only understood how to create with the name that we wanted only later in the process of packaging (see conda-forge/staged-recipes#13551). However, the name of the repo has no influence on the name of the created packages, so both https://github.com/conda-forge/libignition-transport4-feedstock and https://github.com/conda-forge/libignition-gazebo-feedstock (for example) create packages with the name libignition-<library-name><major-version> that can be side-by-side installable as in apt or homebrew. For example https://github.com/conda-forge/libignition-transport4-feedstock creates libignition-transport8, libignition-transport9 and libignition-transport10 (thanks to its branches: https://github.com/conda-forge/libignition-transport4-feedstock/blob/412f8cfbbfef0d9a075e4edf7534b2cc084a421f/conda-forge.yml#L2) and will create libignition-transport11 once conda-forge/libignition-transport4-feedstock#47 is merged.

We never looked in understand if there is a way to rename the repos as that is mostly a cosmetic issue, and we do not know if a repo name change would create problems in the conda-forge bot infrastructure, that is quite complex to handle things like ABI migrations (see https://conda-forge.org/blog/posts/2019-12-06-cfep09/).

[traversaro]

@chapulina All the Fortress ignition packages now have binaries on conda-forge. We still have some issues (see conda-forge/libignition-gazebo-feedstock#27, conda-forge/libignition-gazebo-feedstock#6) and ign gazebo starts correctly only on Linux (mainly due to gazebosim/gz-tools#7 and other issues), but the basic library functionality is there.

[chapulina]

That's awesome, @traversaro ! Thanks for all the work!