The next Open-RMF release checklist

[Yadunund]

The release will target:

• OS: Ubuntu Jammy 22.04
• ROS Distros: Humble, Iron and Rolling

Specifically we will aim to have two types of releases

1. Source release: Suitable branches and rmf.repos files with exact tags of each package will be created here. Similar to 21.09

• humble-release
• iron-release

Note: Instead of repos files consider relying on rosinstall_generator.

2. Debian (Binary) release (distributed via ROS Buildfarm):

• humble
• iron
• rolling

Note: The debian release will not include packages from rmf_demos given the known issues [#todo: add link] with distributing these packages.

As part of this release, we will aligned with conventions and practices of ROS 2 releases. One exception will be the default branch for development will continue to be main in Open-RMF as opposed to rolling. We will bloom into ROS 2 Rolling from main.

TODO Checklist (to be completed in order)

• Sync main branches with rolling so that we can deprecate rolling. Update: We can't delete rolling since for some repos we can't bring over commits with tags from rolling into main due to linear history constraints.
  • Sync main with rolling/humble nlohmann_json_schema_validator_vendor#16
  • Bump main to match rolling rmf_battery#39
  • Sync main with rolling rmf_demos#183
  • Sync commits with tags on rolling to main rmf_internal_msgs#57
  • Fix eigen not found when building rpm on main rmf_simulation#102
  • Sync main with rolling rmf_task#87
  • Sync main with rolling rmf_traffic_editor#466
  • Sync main with rolling rmf_visualization#56
• Convert all pkg's CHANGELOGS.md files to CHANGELOG.rst. This is to align with REP 132 and will greatly improve the ease of updating changelogs in the future as they will be auto-populated when running catkin_generate_changelog.
  • Switch to rst changelog rmf_api_msgs#36
  • Bump 0.3.0 and switch to rst changelogs nlohmann_json_schema_validator_vendor#15
  • Bump 0.3.0 and switch to rst changelogs pybind11_json_vendor#10
  • Bump 0.2.0 and switch to rst changelogs rmf_battery#38
  • Switch to rst changelogs rmf_demos#182
  • Bump 3.1.0 and switch to rst changelogs rmf_internal_msgs#56
  • Switch to rst changelogs rmf_simulation#101
  • Switch to rst changelogs rmf_traffic#100
  • Switch to rst changelogs rmf_traffic_editor#464
  • Updates to rst changelogs rmf_utils#28
  • Switch to rst changelogs rmf_visualization#57
  • Switch to rst changelogs rmf_visualization_msgs#7
• Bump minor version on main for all repos before creating iron branch. This will keep iron pkgs always ahead of humble and we can release API breaking features into iron.
  • Bump 1.3.0 rmf_building_map_msgs#5
  • Bump 2.2.0 rmf_ros2#280
  • Bump 2.1.0 rmf_simulation#103
  • Bump 2.2.0 rmf_task#88
  • Bump 3.1.0 rmf_traffic#101
  • Bump 1.7.0 rmf_traffic_editor#467
  • Bump 1.5.0 rmf_utils#29
  • Bump 2.1.0 rmf_visualization#59
  • Bump 1.3.0 rmf_visualization_msgs#8
• Create iron branch from main on all repos.
• Update tracks.yaml in the release repos
  • Update devel_branch for humble, iron and rolling ros2-gbp/ament_cmake_catch2-release#1
    • Reset humble to rolling
  • Update devel_branch for iron and rolling ros2-gbp/menge_vendor-release#1
  • Update devel_branch for iron and rolling ros2-gbp/nlohmann_json_schema_validator_vendor-release#1
  • Update devel_branch for iron and rolling ros2-gbp/pybind11_json_vendor-release#1
  • Update devel_branch for iron and rolling ros2-gbp/rmf_api_msgs-release#1
  • Update devel_branch for iron and rolling ros2-gbp/rmf_battery-release#1
    • reset humble to match rolling -> merged rolling into humble and did a patch bump.
  • Update devel_branch for iron and rolling ros2-gbp/rmf_building_map_msgs-release#1
  • Update devel_branch for iron and rolling ros2-gbp/rmf_internal_msgs-release#1
  • Update devel_branch for iron and rolling ros2-gbp/rmf_ros2-release#1
  • Update devel_branch for iron and rolling ros2-gbp/rmf_simulation-release#1
  • Update devel_branch for iron and rolling ros2-gbp/rmf_task-release#1
  • Update devel_branch for iron and rolling ros2-gbp/rmf_traffic-release#1
  • Update devel_branch for iron and rolling ros2-gbp/rmf_traffic_editor-release#1
  • Update devel_branch for iron and rolling ros2-gbp/rmf_utils-release#1
    • Reset humble to main for rmf_utils
  • Update devel_branch for iron and rolling ros2-gbp/rmf_visualization-release#1
  • Update devel_branch for iron and rolling ros2-gbp/rmf_visualization_msgs-release#1
    • Reset humble to main for rmf_visualization_msgs
• Bloom packages into iron
  • ament_cmake_catch2: 1.3.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37477
  • menge_vendor: 1.1.0-1 in 'iron/distribution.yaml' ros/rosdistro#37478
  • nlohmann_json_schema_validator_vendor: 0.3.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37491
  • pybind11_json_vendor: 0.3.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37492
  • rmf_api_msgs: 0.1.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37493
  • rmf_battery: 0.2.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37494
  • rmf_building_map_msgs: 1.3.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37495
  • rmf_internal_msgs: 3.1.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37496
  • rmf_ros2: 2.2.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37497
  • rmf_simulation: 2.1.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37498
  • rmf_task: 2.2.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37499
  • rmf_traffic: 3.1.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37500
  • rmf_traffic_editor: 1.7.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37501
  • rmf_utils: 1.5.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37502
  • rmf_visualization: 2.1.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37503
  • rmf_visualization_msgs: 1.3.0-1 in 'iron/distribution.yaml' [bloom] ros/rosdistro#37504
• Bump patch version and bloom packages into humble
  • ament_cmake_catch2: 1.2.1-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37425
  • menge_vendor: 1.0.1-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37426
  • nlohmann_json_schema_validator_vendor: 0.2.5-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37431
  • pybind11_json_vendor: 0.2.3-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37432
  • rmf_api_msgs: 0.0.2-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37433
  • rmf_battery: 0.1.5-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37434
  • rmf_building_map_msgs: 1.2.1-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37435
  • rmf_internal_msgs: 3.0.3-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37441
  • rmf_ros2: 2.1.6-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37442
  • rmf_simulation: 2.0.1-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37443
  • rmf_task: 2.1.4-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37455
  • rmf_traffic: 3.0.1-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37456
  • rmf_traffic_editor: 1.6.1-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37457
  • rmf_utils: 1.4.1-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37458
  • rmf_visualization_msgs: 1.2.1-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37459
  • rmf_visualization: 2.0.2-1 in 'humble/distribution.yaml' [bloom] ros/rosdistro#37460
• Bump minor version on main for all repos so that main remains ahead of iron.
  • Bump 1.4.0 ament_cmake_catch2#5
  • Bump 1.2.0 menge_vendor#12
  • Bump 0.4.0 nlohmann_json_schema_validator_vendor#17
  • Bump 0.2.0 rmf_api_msgs#40
  • Bump 0.2.0 rmf_api_msgs#40
  • Bump 0.4.0 nlohmann_json_schema_validator_vendor#17
  • Bump 1.2.0 menge_vendor#12
  • Bump 1.4.0 ament_cmake_catch2#5
  • Bump 1.4.0 rmf_building_map_msgs#6
  • Bump 3.2.0 rmf_internal_msgs#58
  • Bump 2.3.0 rmf_ros2#282
  • Bump 2.2.0 rmf_simulation#104
  • Bump 3.2.0 rmf_traffic#102
  • Bump 1.8.0 rmf_traffic_editor#468
  • Bump 1.6.0 rmf_utils#30
  • Bump 1.4.0 rmf_visualization_msgs#9
• Bloom packages into rolling
  • pybind11_json_vendor: 0.4.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37545
  • rmf_battery: 0.3.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37546
  • rmf_task: 2.3.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37547
  • rmf_visualization: 2.2.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37548
  • nlohmann_json_schema_validator_vendor: 0.4.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37552
  • menge_vendor: 1.2.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37551
  • ament_cmake_catch2: 1.4.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37550
  • rmf_api_msgs: 0.2.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37553
  • rmf_building_map_msgs: 1.4.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37554
  • rmf_internal_msgs: 3.2.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37555
  • rmf_ros2: 2.3.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37556
  • rmf_simulation: 2.2.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37557
  • rmf_traffic: 3.2.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37558
  • rmf_traffic_editor: 1.8.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37559
  • rmf_utils: 1.6.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37560
  • rmf_visualization_msgs: 1.4.0-1 in 'rolling/distribution.yaml' [bloom] ros/rosdistro#37561
• Update open-rmf/rmf.
  • Create iron branch
  • Create iron-release with exact tags of release pkgs
  • Tag iron-release with date of update eg release-iron-230526
  • Create humble branch
  • Create humble-release with exact tags of release pkgs: https://github.com/open-rmf/rmf/blob/humble-release/rmf.repos
  • Tag humble-release with date of update eg release-humble-230526
  • Update README.md: Update Installation instructions after latest releases #360
• Release rmf_dev metapackage
  • Add new release repositories ros2-gbp/ros2-gbp-github-org#267

[Yadunund]

Done!