Skip to content

Remove major version from package name#2726

Merged
scpeters merged 9 commits intomainfrom
scpeters/package_name_without_major_version
Mar 28, 2025
Merged

Remove major version from package name#2726
scpeters merged 9 commits intomainfrom
scpeters/package_name_without_major_version

Conversation

@scpeters
Copy link
Copy Markdown
Member

🎉 New feature

Part of gazebo-tooling/release-tools#1244.

Summary

This removes the major version from the package name in the following places:

  • cmake project name and corresponding find_package calls in examples and tutorials
  • package.xml name
  • python module name and corresponding import statements in tests, examples, and tutorials

Test it

Checklist

  • Signed all commits for DCO
  • 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)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

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

* Update cmake project name, package.xml name
* Remove version from cmake target names
* Change examples to find_package(gz-sim) and
  update target names.

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
Update tests and examples to import gz.sim

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
@scpeters
Copy link
Copy Markdown
Member Author

@osrf-jenkins run tests please

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
Signed-off-by: Steve Peters <scpeters@openrobotics.org>
@scpeters scpeters force-pushed the scpeters/package_name_without_major_version branch from 81082df to 1f21013 Compare January 23, 2025 05:54
Signed-off-by: Steve Peters <scpeters@openrobotics.org>
@scpeters
Copy link
Copy Markdown
Member Author

I saw what looked like a flaky test, confirmed that it flakes locally, reported it in #2727, and restarted the job with the test failure

@scpeters
Copy link
Copy Markdown
Member Author

I think gazebo-tooling/release-tools#1246 would fix the windows CI

@scpeters
Copy link
Copy Markdown
Member Author

gazebo-tooling/release-tools#1246 didn't fix the windows build:

Build Status https://build.osrfoundation.org/job/gz_sim-pr-clowin/297/

I'll try something else

@scpeters
Copy link
Copy Markdown
Member Author

@osrf-jenkins run tests please

@scpeters
Copy link
Copy Markdown
Member Author

I manually configured the most recent job to run with gazebo-tooling/release-tools#1287 and it passed

https://build.osrfoundation.org/job/gz_sim-pr-clowin/299/

@scpeters scpeters marked this pull request as ready for review March 19, 2025 02:28
@scpeters scpeters requested a review from j-rivero March 19, 2025 22:43
scpeters added a commit to gazebosim/gz-launch that referenced this pull request Mar 24, 2025
Companion to gazebosim/gz-sim#2726.

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
scpeters added a commit to gazebosim/gz-launch that referenced this pull request Mar 24, 2025
Companion to gazebosim/gz-sim#2726.

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
scpeters added a commit to gazebosim/gz-jetty that referenced this pull request Mar 24, 2025
Companion to gazebosim/gz-sim#2726.

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
@j-rivero
Copy link
Copy Markdown
Contributor

Works ! I mean I can run gz sim in the usual way.

Not sure if it is under the scope of this first round of changes but we are still using the version in:

./include/gz/sim10
./libexec/gz/sim10
./share/gz/sim10.yaml
./share/gz/gz2.completion.d/sim10.bash_completion.sh

The point for any all these is if we want to keep the version in the paths.

  • For includes/ : given our installation path we could potentially conserve this layout. It would be a weird layout for a software not expecting the parallel installations but would work.
  • For libexec/ : similar to includes/
  • The .yaml gz configuration: unsure about this one
  • The bash completion: seems to go in sync with the yaml gz configuration.

@scpeters
Copy link
Copy Markdown
Member Author

Not sure if it is under the scope of this first round of changes but we are still using the version in:

./include/gz/sim10
./libexec/gz/sim10
./share/gz/sim10.yaml
./share/gz/gz2.completion.d/sim10.bash_completion.sh

The point for any all these is if we want to keep the version in the paths.

  • For includes/ : given our installation path we could potentially conserve this layout. It would be a weird layout for a software not expecting the parallel installations but would work.
  • For libexec/ : similar to includes/
  • The .yaml gz configuration: unsure about this one
  • The bash completion: seems to go in sync with the yaml gz configuration.

these changes are not directly user-facing for developers building with cmake (as opposed to writing compiler flags directly), so I skipped them

we could choose to address them, but would likely need to update the debian metadata

@j-rivero
Copy link
Copy Markdown
Contributor

these changes are not directly user-facing for developers building with cmake (as opposed to writing compiler flags directly), so I skipped them

we could choose to address them, but would likely need to update the debian metadata

+1

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
@scpeters
Copy link
Copy Markdown
Member Author

Not sure if it is under the scope of this first round of changes but we are still using the version in:

./include/gz/sim10
./libexec/gz/sim10
./share/gz/sim10.yaml
./share/gz/gz2.completion.d/sim10.bash_completion.sh

The point for any all these is if we want to keep the version in the paths.

  • For includes/ : given our installation path we could potentially conserve this layout. It would be a weird layout for a software not expecting the parallel installations but would work.
  • For libexec/ : similar to includes/
  • The .yaml gz configuration: unsure about this one
  • The bash completion: seems to go in sync with the yaml gz configuration.

these changes are not directly user-facing for developers building with cmake (as opposed to writing compiler flags directly), so I skipped them

we could choose to address them, but would likely need to update the debian metadata

one other point is that at least some of this (maybe all) is configured in gz-cmake

for example the include/gz/sim10 paths are specified in the following files:

@github-project-automation github-project-automation bot moved this from In progress to In review in Core development Mar 28, 2025
@j-rivero
Copy link
Copy Markdown
Contributor

There seems to be problem with the Model API on cli on Brew. If these are known or not related, I think we are good to merge.

@scpeters scpeters merged commit 03b2057 into main Mar 28, 2025
8 of 9 checks passed
@scpeters scpeters deleted the scpeters/package_name_without_major_version branch March 28, 2025 18:39
@github-project-automation github-project-automation bot moved this from In review to Done in Core development Mar 28, 2025
@scpeters
Copy link
Copy Markdown
Member Author

There seems to be problem with the Model API on cli on Brew. If these are known or not related, I think we are good to merge.

it only happens on certain CI machines; I think it is unrelated to this change, so I have already merged

@scpeters
Copy link
Copy Markdown
Member Author

nightly build failed; I'll take a look at fixing the debian metadata:

scpeters added a commit to gazebo-release/gz-sim10-release that referenced this pull request Mar 28, 2025
Follow-up to gazebosim/gz-sim#2726.

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
@scpeters
Copy link
Copy Markdown
Member Author

scpeters added a commit to gazebosim/gz-launch that referenced this pull request Mar 30, 2025
Companion to gazebosim/gz-sim#2726.

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
scpeters added a commit to gazebosim/gz-jetty that referenced this pull request Mar 30, 2025
Companion to gazebosim/gz-sim#2726.

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
scpeters added a commit to gazebo-release/gz-sim10-release that referenced this pull request Mar 31, 2025
Follow-up to gazebosim/gz-sim#2726.

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
scpeters added a commit to gazebosim/gz-jetty that referenced this pull request Mar 31, 2025
Companion to gazebosim/gz-sim#2726.

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants