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.

Sign up for GitHub

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

Add colcon.pkg with gz-cmake4 dependency #142

Merged
merged 2 commits into from
Apr 22, 2024
Merged

Add colcon.pkg with gz-cmake4 dependency #142

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac88b18
colcon.pkg: add depend on gz-cmake4
scpeters Apr 22, 2024
805d1fd
Add comments
scpeters Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions colcon.pkg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Configuration file for colcon (https://colcon.readthedocs.io).
Copy link
Contributor

Choose a reason for hiding this comment

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

We also want to mention why we are adding this file here so we remember the original cause to introduce the file and listing only a subset of the versions that the sotfware can depend on.

Copy link
Member Author

Choose a reason for hiding this comment

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

comments added in 805d1fd

#
# Please see the doc for the details of the spec:
# - https://colcon.readthedocs.io/en/released/user/configuration.html#colcon-pkg-files

{
# explicitly add gz-cmake4 as a dependency since it is not included in the package.xml
# see https://github.com/gazebosim/gz-tools/pull/142 for discussion of alternatives
"dependencies": ["gz-cmake4"],
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"dependencies": ["gz-cmake4"],
"build-dependencies": ["gz-cmake4"],

Quoting: https://colcon.readthedocs.io/en/released/user/configuration.html#colcon-pkg-files

dependencies (list of strings) to declare additional dependencies on other packages. For more fine grain control it is also possible to set build-dependencies, run-dependencies, and test-dependencies.

Copy link
Contributor

@cottsay cottsay Apr 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Tricky.

Is gz-cmake4 required when a package which depends on gz-tools is built? If so, it would also need to be in run-dependencies. At that point it's probably easier to leave it as-is.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll leave this as is for now and merge to fix CI. We can follow up with other approaches after CI is fixed

}