Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds a CI check to ensure vendordep JSON files in the project match those published in the pioneerslib artifact.
- Introduces a GitHub Actions workflow that extracts the library version, downloads its vendordeps zip, and runs a comparison.
- Adds a Python script to list and compare vendordep JSON filenames between the project and the library.
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/workflows/compare_vendor_dependencies.yml | Defines the CI workflow steps for version extraction, zip download, extraction, and comparison. |
| .github/scripts/compare_vendordeps.py | Implements the comparison logic to detect missing vendordep JSON files and exits with an error if any are missing. |
Comments suppressed due to low confidence (3)
.github/workflows/compare_vendor_dependencies.yml:34
- [nitpick] The directory name pioneerslib_vendordeps (using underscores) is inconsistent with the hyphenated vendordeps zip filename. Consider aligning naming conventions (e.g., pioneerslib-vendordeps) for clarity.
mkdir pioneerslib_vendordeps
.github/scripts/compare_vendordeps.py:1
- Consider adding a module-level docstring above the imports to describe the script’s purpose and usage for better maintainability and clarity.
import sys
.github/scripts/compare_vendordeps.py:17
- There are no unit tests covering scenarios like missing vendordep files or empty folders. Adding tests for these cases will help ensure the comparison logic remains correct.
if missing_from_project:
Closed
Contributor
Author
|
This PR also makes changes in the team lib: FRC-7525/PioneersLib#22 |
Contributor
Author
|
See #16 for improvements to be made |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.