Rename Ignition to Gazebo

[chapulina]

See the announcement. This issue is meant to capture the technical tasks involved in the migration.

• Transfer GitHub orgs and repos
  • ignitionrobotics ➡️ gazebosim
  • ignition-release ➡️ gazebo-release
  • ignition-forks ➡️ gazebo-forks
  • ignition-tooling ➡️ gazebo-tooling
  • Source repos
    • Archived repos keep their names if that's easier
    • s/ign/gz
    • s/gazebo/sim
  • Release repos
    • archived repos keep their names if that's easier
    • release repos for Citadel and Fortress should probably keep their names if that's easier
    • all other release repos: s/ign/gz
  • Tooling repos
    • s/ign/gz
    • s/ignition/gz
    • Most won't change

Docs

• Tutorials
• ign to gz: UI, API docs #728
• ign to gz : Partial Docs Migration and Project Name Followups #757
• Add migration guide to Garden docs gazebosim/docs#275

Build tools

• CMake variables (anything that's set())
  • Some args/options too! (NO_IGNITION_PREFIX, REPLACE_IGNITION_INCLUDE_PATH)
  • Internal vars and options: ign -> gz Migrate Internal CMake Vars : gz-cmake gazebosim/gz-cmake#275
  • BREAKING: PROJECT_INCLUDE_DIR value
  • Downstream usages:
    • ign to gz : Remaining Files, and Python Libraries/Namespaces #765, pending 274, 275
    • ign to gz : Provisional Finale #767
• CMake project names from ignition to gz #718
• CMake API from ign to gz #719
• CMake files in gz-cmake
  • FindXXX: ign -> gz FindXXX migration : gz-cmake gazebosim/gz-cmake#273
  • IgnXXX.cmake ign -> gz CMake, Config, and Example Files migration : gz-cmake gazebosim/gz-cmake#274 (pending 273, above)
  • Internal config files ign -> gz CMake, Config, and Example Files migration : gz-cmake gazebosim/gz-cmake#274
• Github workflows (ignition-tooling, action-ignition-ci)
  • ign to gz : Remaining Files, and Python Libraries/Namespaces #765
  • ign to gz : Provisional Finale #767
• Package and homebrew install names (libignition-XXX, ignition-)
  • ign to gz : Remaining Files, and Python Libraries/Namespaces #765
  • ign to gz : Provisional Finale #767
  • Rename garden bottles from ignition-* to gz-* osrf/homebrew-simulation#1961
    • Garden: rename ignition-* formulae to gz-* osrf/homebrew-simulation#1994
• Rename ign-docker-env to gz-docker-env gzdev#61

Release

• Debian packages from ignition to gz #736
• ign -> gz: gz debs for Citadel and Fortress #788
• rosdep keys Add gz keys for Gazebo Citadel and Fortress ros/rosdistro#34177
• Homebrew formulae Garden: rename ignition-* formulae to gz-* osrf/homebrew-simulation#1994
• ign to gz : release-tools and build scripts #745
• ros_gz release script
  ign -> gz ros_gz Migration : Migrate ros_gz release script #764
• Jenkins CI job names (and references in source)

Source Edits

• Remaining files: ign to gz : Remaining Files, and Python Libraries/Namespaces #765
• Ruby binding namespaces ign to gz : Remaining Files, and Python Libraries/Namespaces #765
• Python binding namespaces: ign to gz : Remaining Files, and Python Libraries/Namespaces #765
  • (in Python files like this one, we import ignition.math), it should be ticktocked (maybe here, for math and with the file moved?)
• Any remaining variable or class names
  • ign to gz : Provisional Finale #767
• Transport topics with /ignition prefix (e.g. on gz-sensors)
• Custom SDFormat parameters in ignition: xml namespace
  • ign to gz : Shared Libs and SDF attributes (systems and plugins) #744
• C++ namespaces, directories and header guards from ignition to gz #711
• ign to gz : CLI #739
• Environment variables from IGN to GZ #734
• Macros from IGN to GZ #737
• ign to gz : Shared Libs and SDF attributes (systems and plugins) #744
• Rendering: https://github.com/gazebosim/gz-rendering/blob/main/ogre2/src/Ogre2GzHlmsPbsPrivate.cc#L283 Hlms/Ignition/... paths
  ign to gz : Remaining Files, and Python Libraries/Namespaces #765
• IgnSpinBox
  • ign to gz : Provisional Finale #767
• fuel.ignitionrobotics.org paths
  • PENDING?

Downstream Libs

• gz_ros
  • Migration: ign -> gz : ros_gz Migration gazebosim/ros_gz#262
  • Shims: WIP

Random TODOs...

• .ign suffixed files in gz-launch
  ign to gz : Remaining Files, and Python Libraries/Namespaces #765
  • <ignition> tag for launch files (.ign files) (<ignition version='1.0'>)
    ign to gz : Remaining Files, and Python Libraries/Namespaces #765
• NO_IGNITION_PREFIX and associated logic
  ign to gz : Remaining Files, and Python Libraries/Namespaces #765
• Material names? e.g. ign-grey from TransportSceneManager
  ign to gz : Remaining Files, and Python Libraries/Namespaces #765
• kIgnAuthDomain
  ign to gz : Remaining Files, and Python Libraries/Namespaces #765
• fuel-tools: X-Ign-Resource-Version, IgnitionFuelTools user agent, fuel cache and config paths (.ignition/), ${CMAKE_INSTALL_DATAROOTDIR}/
• /.ignition/? Config paths?
• gui: ign-gui-qml, /.ignition/gui/plugins
  • ign to gz : Provisional Finale #767

[traversaro]

If the ign tool in https://github.com/ignitionrobotics/ign-tools is renamed in gz, there is the possibility of a collision with the Gazebo Classic gz tool. Do you have any idea on how we can handle that?

[chapulina]

If the ign tool in https://github.com/ignitionrobotics/ign-tools is renamed in gz, there is the possibility of a collision with the Gazebo Classic gz tool. Do you have any idea on how we can handle that?

This is something we've been discussing. Some possible outcomes:

• Gazebo Garden+ and Gazebo Classic can't be installed side-by-side. Garden and Gazebo 11's support timelines only overlap for 2 years and their only officially supported platform in common is Ubuntu Focal. This may hurt people's migration efforts from Classic to Garden, but they have other 2 LTS versions to target: Citadel and Fortress.

• Move the gz binary from Gazebo classic to a separate debian package, so gazebo11 and libgazebo11-dev wouldn't collide with Garden, only the new "gazebo11-gz" package would. Only a small fraction of users use that tool, so most users shouldn't be affected. But this may be a breaking change to a stable version, which we should avoid. This option isn't available to the packages that are already upstream on Ubuntu.

• Make gz-tools2 smart enough to call into Gazebo Classic's gz tool when that's present. I'm not sure if that's possible, but someone may have a clever idea.

• Call the command line tool something other than gz for gz-tools2. Some suggestions were gzb, gzcli... I'd like to avoid that because this is our chance to be consistent with our naming. For Ignition we had a combination of ignition and ign in different places, which caused lots of confusion. I'd like to stick to gz everywhere with this migration so it's not confusing down the line if we have gz everywhere except for the CLI. gz is also short to type and easy to remember.

And that's not to mention the ign executable... Ideally Garden users should be able to use ign with warnings (tick-tock's tick). But if gz-tools2 installs ign, it may collide with ign-tools1 (Citadel and Fortress).

[chapulina]

If the ign tool in https://github.com/ignitionrobotics/ign-tools is renamed in gz, there is the possibility of a collision with the Gazebo Classic gz tool. Do you have any idea on how we can handle that?

It's been decided to go with:

Gazebo Garden+ and Gazebo Classic can't be installed side-by-side.

[scpeters]

related issue: gazebo-tooling/gzdev#61