Skip to content

[CI] Add Vendor Dep CI#15

Merged
GreenTomato5 merged 11 commits intomainfrom
CI/GreenTomato5_compare_vendor_dependencies
Jul 14, 2025
Merged

[CI] Add Vendor Dep CI#15
GreenTomato5 merged 11 commits intomainfrom
CI/GreenTomato5_compare_vendor_dependencies

Conversation

@GreenTomato5
Copy link
Contributor

No description provided.

@GreenTomato5 GreenTomato5 changed the title Add Vendor Dep CI [CI] Add Vendor Dep CI Jul 11, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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:

@GreenTomato5 GreenTomato5 requested a review from PotmanNob July 11, 2025 21:51
@GreenTomato5 GreenTomato5 mentioned this pull request Jul 11, 2025
@GreenTomato5
Copy link
Contributor Author

This PR also makes changes in the team lib: FRC-7525/PioneersLib#22

@GreenTomato5 GreenTomato5 requested a review from James4356 July 11, 2025 21:55
Copy link
Collaborator

@PotmanNob PotmanNob left a comment

Choose a reason for hiding this comment

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

looks good to me

@GreenTomato5
Copy link
Contributor Author

See #16 for improvements to be made

@GreenTomato5 GreenTomato5 merged commit 56a8244 into main Jul 14, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants