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.

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

Add SPDX 3 format example for software/example1 #101

Merged
merged 1 commit into from
Sep 26, 2024
Merged

Conversation

goneall
Copy link
Member

@goneall goneall commented Sep 11, 2024

This example was generated from the SPDX Java tools.

Please review - any feedback can be incorporated into the tools.

Once this example looks OK, I can generate the additional examples in SPDX 3 format.

@JPEWdev
Copy link
Contributor

JPEWdev commented Sep 24, 2024

The spdx-validate tool needs to be updated for 3.0.1, then validation should pass. I'll change that and publish it.

"@id" : "_:creationInfo_0",
"type" : "CreationInfo",
"specVersion" : "3.0.1",
"createdBy" : [ "https://swinslow.net/spdx-examples/example1/hello-v3-specv3/SPDXRef-gnrtd0" ],
Copy link
Collaborator

Choose a reason for hiding this comment

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

IDs need to be globally unique (#85 (comment)). I wonder how that affects the conversion. I don't recall SPDXRef id's being globally unique.

Copy link
Member Author

Choose a reason for hiding this comment

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

For the conversion, I take the document namespace (which is globally unique) and append either the original SPDXRef (if available) or a unique generated SPDXRef which should always result in a globally unique ID.

"type" : "CreationInfo",
"specVersion" : "3.0.1",
"createdBy" : [ "https://swinslow.net/spdx-examples/example1/hello-v3-specv3/SPDXRef-gnrtd0" ],
"createdUsing" : [ "https://swinslow.net/spdx-examples/example1/hello-v3-specv3/additionalToolSPDXRef-gnrtd2", "https://swinslow.net/spdx-examples/example1/hello-v3-specv3/additionalToolSPDXRef-gnrtd1" ],
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm wondering if one does a conversion, does the conversion tool need to be included here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good question @nishakm - I wonder if the conversion tool should always insert itself into the createdUsing. That being said, it would change the actual data and would result in a "new" document rather than a straight conversion.

I'm thinking we leave it out for now - but something to think about for the conversion tool in general.

Copy link
Collaborator

@nishakm nishakm left a comment

Choose a reason for hiding this comment

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

I have a couple of questions, but other than that LGTM.

@goneall
Copy link
Member Author

goneall commented Sep 26, 2024

Thanks @nishakm - I'll go ahead and merge based on the reviews so far. I think I answered the questions above, but feel free to continue the conversations after the merge.

@goneall goneall merged commit 88a7203 into master Sep 26, 2024
0 of 2 checks passed
@goneall goneall deleted the swex1spdx3 branch September 26, 2024 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants