Update SPDX predicate specification #187
Merged
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
This commit contains a suggestion for updating the SPDX predicate specification, to include the version in the predicateType. The motivation for this change is same to the motivation that was mentioned for including the version in the CycloneDX predicate specification which is that it allows a consumer to determine the version without having to parse the predicate itself. Signed-off-by: Daniel Bevenius <[email protected]>
danbev
force-pushed
the
spdx-predicatetype-version-suggestion
branch
from
eaef337
to
89d76d6
Compare
joshuagl
reviewed
Apr 12, 2023
| @@ -1,47 +1,69 @@ | |||
| # Predicate type: SPDX | |||
|
|
|||
| Type URI: (tentative) https://spdx.dev/Document | |||
| Type URI: https://spdx.dev/Document | |||
There was a problem hiding this comment.
Should we somehow indicate that the Type URI MUST include a version?
Suggested change
| Type URI: https://spdx.dev/Document | |
| Type URI: https://spdx.dev/Document/v${SPDX_MAJOR}.${SPDX_MINOR} |
There was a problem hiding this comment.
That makes sense to me 👍
It would probably makes sense to also update the CycloneDX predicate specification in that case, as it does not include the version in the Type URI:
Type URI: https://cyclonedx.org/bom
There was a problem hiding this comment.
I like this idea, though we haven't required this in other predicate definitions either.
This may be a question beyond the scope of this PR, but it seems like we might want to be clearer in our documentation for predicateTypes.
Add the removed TODO. Signed-off-by: Daniel Bevenius <[email protected]>
marcelamelara
approved these changes
Apr 12, 2023
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.
This commit contains a suggestion for updating the SPDX predicate specification, to include the version in the
predicateType.The motivation for this change is same to the motivation that was mentioned for including the version in the CycloneDX predicate specification which is that it allows a consumer to determine the version without having to parse the predicate itself.