Skip to content

Improve documentation on versioning Gazebo-ROS vendor packages#677

Open
azeey wants to merge 5 commits intogazebosim:masterfrom
azeey:bloom_track
Open

Improve documentation on versioning Gazebo-ROS vendor packages#677
azeey wants to merge 5 commits intogazebosim:masterfrom
azeey:bloom_track

Conversation

@azeey
Copy link
Contributor

@azeey azeey commented Mar 17, 2026

🎉 New feature

Summary

  • Adds better explanation for the versioning scheme, mainly around when to bump minors
  • Adds a section on updating the bloom track when a new ROS release comes out.

Checklist

  • Signed all commits for DCO
  • Added a screen capture or video to the PR description that demonstrates the feature
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • Updated Bazel files (if adding new files). Created an issue otherwise.
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers
  • Was GenAI used to generate this PR? If so, make sure to add "Generated-by" to your commits. (See this policy for more info.)

Generated-by: Gemini 3.0

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by and Generated-by messages.

Backports: If this is a backport, please use Rebase and Merge instead.

azeey added 5 commits March 16, 2026 17:15
Move the ROS vendor package versioning guidelines to a new section at the bottom of the release instructions and add a reference link to it.

Generated-By: Gemini 3.0
Signed-off-by: Addisu Z. Taddese <addisuzt@intrinsic.ai>
Emphasize checking and updating the bloom track when creating new branches for ROS vendor packages, especially after a new ROS release.

Generated-By: Gemini 3.0
Signed-off-by: Addisu Z. Taddese <addisuzt@intrinsic.ai>
Document that the minor version of Gazebo vendor packages may be bumped when the underlying package's major version is updated, which occurs during a new Gazebo collection release.

Generated-By: Gemini 3.0
Signed-off-by: Addisu Z. Taddese <addisuzt@intrinsic.ai>
Detail two scenarios for bloom track updates: one for core vendor packages (cmake, utils, math) involving manual editing of tracks.yaml, and another for non-core packages using '--edit-track'.

Generated-By: Gemini 3.0
Signed-off-by: Addisu Z. Taddese <addisuzt@intrinsic.ai>
Signed-off-by: Addisu Z. Taddese <addisuzt@intrinsic.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Inbox

Development

Successfully merging this pull request may close these issues.

1 participant