-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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 black-pip key for debian and ubuntu #44281
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for sending a pull request to ROS distro!
This is an automated tool that helps check your pull request for correctness.
This tool checks a number of attributes associated with your ROS package and generates a report that helps our reviewers merge your pull request in a timely fashion. Here are a few things to consider when sending adding or updating a package to ROS Distro.
ROS Distro includes a very helpful CONTRIBUTING.md file that we recommend reading if it is your first time submitting a package.
Please also read the ROS Distro review guidelines which summarizes this release process.
ROS Distro Considerations
- ROS Distributions are created using REP-134 Standards Track as a guide.
- Your package name should comply to REP-144 ROS Package Naming
- Your package must build for all platforms and architectures on the ROS buildfarm. See REP-2000 ROS Releases and Supported Platforms for all supported platforms for your ROS Distro.
- Your package must contain an OSI approved license. Your
package.xml
file must also include that license in a machine readable format. See REP-149 Package Manifest Format Three Specification for additional details. - A publicly available, open source, repository for your ROS package.
- While not required, we recommend that you create an account for ROS Discourse and subscribe to the appropriate release topic.
- If you would like, you may join our Discord Server and ask questions in the
#infra-help
channel.
Package Considerations
Having your package included in a ROS Distro is a badge of quality, and we recommend that package developers strive to create packages of the highest quality. We recommend package developers review the following resources before submitting their package.
- REP-2004 Package Quality Declaration-- The ROS 2 TSC has created a quality rating system for ROS packages. These ratings should serve as a guide for package developers. We recommend package developers achieve a quality level of three or higher.
- Documentation -- it is recommended that ROS packages include an extensive README.md file, and API level documentation using the Sphinx documentation system.
- Maintainer Responsibilities -- the ROS 2 documentation includes a guide to ROS package maintainer responsibilities that summarizes your responsibilities as an open source maintainer. While we do not enforce these requirements on package maintainers they should be considered best practices.
- We recommend that your package should strive to conform to the ROS 2 Developer Guide and the ROS 2 Style Guide.
Need Help?
Please post your questions to Robotics Stack Exchange or refer to the #infra-help
channel on our Discord server.
For changes related to rosdep:
- ✅ New rosdep keys are named appropriately
- ✅ Platforms for new rosdep rules are valid
- ✅ Installers for new rosdep rules are valid
For changes related to yamllint:
- ✅ All new lines of YAML pass linter checks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Black is packaged in the native packaging: https://packages.ubuntu.com/oracular/black
This rule will cause conflicts with users of the native packaging and so we can't add a pip rule for this. There are definitely new features in lots of packages but we have to keep coordinated with the broader distribution.
Thanks @tfoote, I meant for this to only be an alternative to the native, not a replacement. Also, I see a precedent set elsewhere to allow the pip package to be added as an option if the native package is a major release behind: https://github.com/ros/rosdistro/pull/40564/files Is this precedent no longer being followed? |
We have a very clear policy in the review guidelines: https://github.com/ros/rosdistro/blob/master/REVIEW_GUIDELINES.md I will be submitting a revert for the linked PR at #44287 |
Please add the following dependency to the rosdep database.
Package name:
black-pip
Package Upstream Source:
https://github.com/psf/black
Purpose of using this:
In apt the current version supported is 21.12b0 and the latest stable version available from black is 24.10.0 which includes bug fixes and feature updates that are desired. Also, 21.12b0 is not supported by the VS Code black extension.
Links to Distribution Packages