-
Notifications
You must be signed in to change notification settings - Fork 33
Applies_to: Expand versioning features #2322
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
base: main
Are you sure you want to change the base?
Conversation
…r applicabilities
🔍 Preview links for changed docs |
…out a specified version
reakaleek
left a comment
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.
There are two test cases that made me curious.
Otherwise, LGTM.
Nice work.
| "sub_type": "stack", | ||
| "lifecycle": "ga", | ||
| "version": "9999.9999.9999" | ||
| "version": "all" |
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.
➕ thanks for fixing this and making it properly.
|
I'm wondering a bit why there are so many warnings. What's the reason we can't do this backwards compatible? |
…Popover.tsx Co-authored-by: florent-leborgne <[email protected]>
Co-authored-by: Visha Angelova <[email protected]>
florent-leborgne
left a comment
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.
LGTM functionally what's implemented here works as expected.
- Some corner cases (that are more about handling contribution mistakes or very rare scenarios) might still require fixing or better validation handling
- This PR doesn't seem to implement the
x.x.x!syntax to force showing patches - this is fine for me as I don't think we need it
It'd be nice to get this merged soon so we can do a cleanup pass with the cumulative docs group on the content, so that we can re-enable warnings asap.
This PR provides a set of adjustments to the inner workings of versioning in the context of applies_to. This draft will be further updated with front-end changes, but badge-related changes can be checked independently.
It is part of #2135.
Problem description
Describing versions within applicability contains several quirks and limitations, such as:
Proposed changes
Version Specification (VersionSpec)
A new
VersionSpecclass has been created. It builds on SemVersion, and supports the following versioning types:Simplified Badge Display
9.5.0, 9.5.1, 9.5.6 -> all display as 9.5 or 9.5+
Base Version Display
When no version is specified for versioned products, the base version is now shown:
Before:
stack: ga-> Badge shows just "Stack"After:
stack: ga-> Badge shows "Stack│8.0+" (assuming base = 8.0)Unversioned products continue to show no version.
Validation Rules
Implemented validation in
ApplicableToYamlConverter:Tooltip -> Popover overhaul
The badge tooltip was replaced by a popover component.