docs: fix examples for versionRange according to VERS spec
#415
Conversation
This file contains 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
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Merged
prabhu
reviewed
Mar 25, 2024
prabhu
reviewed
Mar 25, 2024
| - "vers:cargo/9.0.14" | ||
| - "vers:npm/1.2.3|>=2.0.0|<5.0.0" | ||
| - "vers:pypi/0.0.0|0.0.1|0.0.2|0.0.3|1.0|2.0pre1" | ||
| - "vers:tomee/>=1.0.0-beta1|<=1.7.5|>=7.0.0-M1|<=7.0.7|>=7.1.0|<=7.1.2|>=8.0.0-M1|<=8.0.1" |
There was a problem hiding this comment.
For the vers to be correct, the ranges must also be normalized as explained here. For instance, let's take an incorrectly normalized vers where <=8.0.1 is at the front.
vers:tomee/<=8.0.1|>=1.0.0-beta1|<=1.7.5|>=7.0.0-M1|<=7.0.7|>=7.1.0|<=7.1.2|>=8.0.0-M1
This would unfortunately match more versions than necessary. For now, we perhaps only add a warning since the intention here is to capture the range and not to use it for validation.
stevespringett
approved these changes
Mar 25, 2024
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.
as pointed out here: https://github.com/CycloneDX/specification/pull/323/files/7a9208afa88c5229759538d425e2e81a1207df65#r1536923617
this fixes the
versionRangeexamples.