Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(controllers)!: remove robot description parameter #186

Merged
merged 5 commits into from
Jan 15, 2025

Conversation

domire8
Copy link
Member

@domire8 domire8 commented Jan 6, 2025

Description

This PR removes the robot_description parameter of the controller interface because the robot description is already available through get_robot_description() of the ros2 control base class.

Breaking change and requires new base image, goes into staging branch

Review guidelines

Estimated Time of Review: 5 minutes

Checklist before merging:

  • Confirm that the relevant changelog(s) are up-to-date in case of any user-facing changes

@domire8 domire8 force-pushed the feat/robot-desc-topic branch from a9f1eea to 289f83f Compare January 7, 2025 09:29
@domire8 domire8 marked this pull request as draft January 7, 2025 10:01
CHANGELOG.md Outdated Show resolved Hide resolved
@domire8 domire8 changed the title feat!(controllers): remove robot description parameter feat(controllers)!: remove robot description parameter Jan 15, 2025
aica-package.toml Outdated Show resolved Hide resolved
@domire8 domire8 marked this pull request as ready for review January 15, 2025 06:05
Copy link
Member

@eeberhard eeberhard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

technically I don't think this is a breaking change, because trying to set a parameter that doesn't exist fails but doesn't result in an error. And the controller behavior should stay the same whether it gets the robot description from the parameter or from the controller manager. Especially as the parameter was marked internal, removing it also shouldn't change any user experience.

Still, I don't mind it being staged on a breaking branch for now for testing

@domire8
Copy link
Member Author

domire8 commented Jan 15, 2025

technically I don't think this is a breaking change

Hmm true, however we will have to release this as part of v6 because of the base image change IMO. This would not work with the current v2.0.0-jazzy image.

Especially as the parameter was marked internal, removing it also shouldn't change any user experience.

It is marked internal, but downstream controllers might fail to configure if it's not available so that's another reason to call it "breaking"

@domire8 domire8 merged commit 97aadd5 into breaking Jan 15, 2025
4 checks passed
@domire8 domire8 deleted the feat/robot-desc-topic branch January 15, 2025 07:22
@github-actions github-actions bot locked and limited conversation to collaborators Jan 15, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants