Skip to main content

build coverage pypi

Automation for analyzing changes to the rosdep database and rosdistro index

The rosdistro index and rosdep database hold a significant amount of semi-manually curated information about various types of packages and how they are associated. To facilitate maintenance of this data and discourage modifications which might introduce unexpected behavior for users, robust automation is needed to validate proposed changes.

This tool analyzes a git repository containing changes to the rosdistro index and/or rosdep database and provides specific and actionable feedback. It is also capable of posting that feedback directly to a content forge like GitHub as a pull request review.

Invoking rosdistro-reviewer locally

Nearly all of the validation that rosdistro-review does can be performed locally. To run the analysis, just run rosdistro-reviewer from anywhere in the git repository you’d like to check. By default, the tool will only analyze uncommitted changes against the most recent commit. If you’ve already committed your changes and you’d still like to check them, you can choose a different target ref with the --target-ref option. For example:

$ rosdistro-reviewer --target-ref origin/master

  ✅ No changes recommended
 /————————————————————————————————————————————————————————————————————————————\
 | For changes related to rosdep:                                             |
 | * ✅ New rosdep keys are named appropriately                               |
 |                                                                            |
 | For changes related to yamllint:                                           |
 | * ✅ All new lines of YAML pass linter checks                              |
 \————————————————————————————————————————————————————————————————————————————/

Running rosdistro-reviewer in GitHub Actions

When a rosdistro pull request is opened or updated on GitHub which contains changes that this tool can process, it is invoked using GitHub Actions and the resulting analysis is posted to the pull request as a review by the user github-actions[bot]. The rosdistro review team uses the information presented by this review to determine if proposed commits require changes before merging.

example GitHub pull request review

Metadata

Release files for rosdistro-reviewer 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rosdistro-reviewer 0.2.0
File Size Uploaded
rosdistro_reviewer-0.2.0.tar.gz 41.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for rosdistro-reviewer 0.2.0
File Interpreter ABI Platform
rosdistro_reviewer-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 76.3 kB

Release files / rosdistro_reviewer-0.2.0.tar.gz

Download URL rosdistro_reviewer-0.2.0.tar.gz
Size 41.4 kB
Tags Source
SHA-256 checksum
How to use checksums
748c1909c96a676608f9666a0a2f9ce8a1194b2e03493a0c7a0f223dd658b7dd
BLAKE2b-256 checksum
How to use checksums
8661763fbee51494fcadaaea1b46f60f4ec247f6a50ac909d713a61806b2061d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/59.8.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.10

Release files / rosdistro_reviewer-0.2.0-py3-none-any.whl

Download URL rosdistro_reviewer-0.2.0-py3-none-any.whl
Size 34.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
126ac0e7e1fb7c32a5a753972d342766e24a267d4f35f620151b6fa97751e332
BLAKE2b-256 checksum
How to use checksums
1d6b97d47e0ec7c4df3d93d4c1a06d3a838ff00227c2386a135635f7badb7420
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/59.8.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.10

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page