-
Notifications
You must be signed in to change notification settings - Fork 109
Add "skipped-versions" index.json field for the ability to skip testing of broken library versions #792
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
Conversation
7c63359 to
e3603db
Compare
docs/CONTRIBUTING.md
Outdated
| }, | ||
| { | ||
| "version": "1.0.7", | ||
| "reason": "Resource metadata provided in reflect-config.json." |
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.
This is not a reason to skip, only if it fails. We need maven issues here, broken builds etc.
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.
I've changed the example reason to Integrated reflect-config.json does not parse. (which reflects the issue in practice with the opentelemetry:1.34.0 libraries).
| "skipped-versions": [ | ||
| { | ||
| "version": "1.34.0", | ||
| "reason": "Dependency io.opentelemetry:opentelemetry-api:1.34.0 provides resource metadata inside of a reflect-config.json file." |
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.
reflect-config.json that does not parse.
| } | ||
| } | ||
|
|
||
| static List<String> getSkippedVersions(String libraryModule) { |
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.
Comment please.
| null, | ||
| coordinates.version(), | ||
| List.of(coordinates.version())); | ||
| List.of(coordinates.version()), |
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.
Can be on the same line.
| List<String> testedVersions | ||
| List<String> testedVersions, | ||
| @JsonProperty("skipped-versions") | ||
| List<SkippedVersionEntry> skippedVersions |
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.
Do build tools care about this?
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.
AFAICT, build tools look for specific fields by string when parsing index.json, so any additional fields will just be ignored. This change shouldn't affect build tools.
…g of broken library versions
a812f6e to
d01e9ac
Compare
What does this PR do?
In this PR we introduce a
skipped-versionsfield to the individual librariesindex.jsonfile. This field contains a list of(version, reason)pairs which define versions that we skip testing for, for the reason listed in thereasonfield.When fetching versioned libraries for testing, library versions listed in
skipped-versionsare omitted from testing.Fixes: #757, #743, #734.