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.

Sign up for GitHub

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

Jump to bottom

Specify vendordep json file format #192

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Specify vendordep json file format #192

wants to merge 3 commits into from

Conversation

spacey-sooty
Copy link
Contributor

  • Create accurate specification for current format
  • Add tests to ensure that we don't silently break current format
  • Update errors to point to the specification when it is useful

spacey-sooty
spacey-sooty commented Feb 29, 2024
View reviewed changes
VendordepJsonSpecification.md
| version | String | The version of the vendordep. | No. |
| uuid | String | The unique identifier for the vendordep. Used to avoid replicating vendordeps in projects. | No. |
| mavenUrls | String[] | An array of urls pointing to the root of the maven repository storing the vendordep. | No. |
| extraGroupIds | String[] | | Yes. |
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 don't know what this is or if it's a valid key I got my specifications from https://github.com/wpilibsuite/native-utils/blob/main/src/main/java/edu/wpi/first/nativeutils/vendordeps/WPIVendorDepsExtension.java#L310 and the example json file

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Im also not sure if

        public VendorDependency[] requires;
        public VendorDependency[] conflictsWith;

should be added in here along with the corresponding types

VendordepJsonSpecification.md
Comment on lines +10 to +12
| JavaArtifact | `{ groupId: String, ArtifactId: String, version: String }` |
| JniArtifact | `{ groupId: String, ArtifactId: String, version: String, skipInvalidPlatforms: Boolean, isJar: Boolean, validPlatforms: String[] }` |
| CppArtifact | `{ groupId: String, ArtifactId: String, version: String, libName: String, headerClassifier: String, sharedLibrary: Boolean, skipInvalidPlatforms: Boolean, binaryPlatforms: String[] }` |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure how this should be formatted

@spacey-sooty
Copy link
Contributor Author

I'm guessing I'm missing a lot of things here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@spacey-sooty