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

Add ur_client_library #26529

Merged
merged 4 commits into from
Sep 16, 2020
Merged

Add ur_client_library #26529

merged 4 commits into from
Sep 16, 2020

Conversation

fmauch
Copy link
Contributor

@fmauch fmauch commented Sep 11, 2020

We are currently in the process of splitting the client library from the ur_robot_driver itself. The client library shall be released first so that users can install it using rosdep instead of having to build their workspace in isolation because the library isn't a catkin package.

Copy link
Contributor

@ivanpauno ivanpauno left a comment

Choose a reason for hiding this comment

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

A few questions before merging, but it lgtm:

  • The LICENSE file says Apache, and the package.xml Apache/BSD-2clause/Zlib, is the package multi-licensed? If the other listed licenses are from dependencies, it would be great to clarify that in the package.xml.
  • was the release done with bloom?

release: release/melodic/{package}/{version}
url: https://github.com/UniversalRobots/Universal_Robots_Client_Library-release.git
version: 0.1.0-1
source:
Copy link
Contributor

@ivanpauno ivanpauno Sep 15, 2020

Choose a reason for hiding this comment

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

can you add a doc entry too?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That would require adding a rosdoc.yaml file and mainpage.dox file through the release repository as described here, right?

I didn't want to clutter the source repository with that, as it is quite ROS specific. On the other hand, we have a package.xml file there, already...

Copy link
Contributor

Choose a reason for hiding this comment

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

That would require adding a rosdoc.yaml file and mainpage.dox file through the release repository as described here, right?

I think that's only required when you don't use doxygen (see here), maybe @cottsay can chime in.

Copy link
Member

Choose a reason for hiding this comment

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

Sorry, I have absolutely no experience with the doc generation...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As I have already added a doc entry for the Universal Robots ROS Driver which created also documentation for contained packages, which don't have a respective rosdoc.yaml and mainpage.dox such as ur_calibration it should be fine adding a doc entry without explicitly setting this up.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've added a doc section to this PR.

@fmauch
Copy link
Contributor Author

fmauch commented Sep 15, 2020

A few questions before merging, but it lgtm:

  • The LICENSE file says Apache, and the package.xml Apache/BSD-2clause/Zlib, is the package multi-licensed? If the other listed licenses are from dependencies, it would be great to clarify that in the package.xml.

There are upstream components included which are released under the respective licenses. I'll clarify this in more detail.

  • was the release done with bloom?

Yes, however, aquiring the GH token did not work, which is why I made the PR by hand.

@ivanpauno
Copy link
Contributor

There are upstream components included which are released under the respective licenses. I'll clarify this in more detail.

Thanks!

Yes, however, aquiring the GH token did not work, which is why I made the PR by hand.

Sounds good

Copy link
Member

@cottsay cottsay left a comment

Choose a reason for hiding this comment

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

This LGTM.

It would be good, however, if your CMakeLists.txt installed the package.xml you're including in the repository. It looks like maybe the CMakeLists.txt is aware if whether it is in a ROS build or not, so maybe you could conditionally install it based on that. If that isn't the case, it might also be possible to patch the CMakeLists.txt in the release repository.

release: release/melodic/{package}/{version}
url: https://github.com/UniversalRobots/Universal_Robots_Client_Library-release.git
version: 0.1.0-1
source:
Copy link
Member

Choose a reason for hiding this comment

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

Sorry, I have absolutely no experience with the doc generation...

@fmauch
Copy link
Contributor Author

fmauch commented Sep 15, 2020

@ivanpauno I've added a license section to the README to clarify all licenses included in this package.

Also, I've added an install statement for the package.xml file given that catkin is found.

If you think, that this should be sufficient, I'll release a version 0.1.1 including those changes.

Copy link
Member

@cottsay cottsay left a comment

Choose a reason for hiding this comment

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

Also, I've added an install statement for the package.xml file given that catkin is found.

If you think, that this should be sufficient, I'll release a version 0.1.1 including those changes.

Looks great, thanks!

@fmauch
Copy link
Contributor Author

fmauch commented Sep 15, 2020

Everything should be setup accordingly.

Copy link
Contributor

@ivanpauno ivanpauno left a comment

Choose a reason for hiding this comment

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

Thanks @fmauch

@ivanpauno ivanpauno merged commit d8f0ccf into ros:master Sep 16, 2020
@fmauch fmauch deleted the ur_client_library branch May 31, 2021 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants