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

Suggested naming convention for SPDX v3 files #987

Open
bact opened this issue Jul 10, 2024 · 7 comments
Open

Suggested naming convention for SPDX v3 files #987

bact opened this issue Jul 10, 2024 · 7 comments
Milestone

Comments

@bact
Copy link
Collaborator

bact commented Jul 10, 2024

SPDX v2 has a suggested naming convention:

Format Extension
tag:value *.spdx
RDF *.spdx.rdf
JSON *.spdx.json
XML *.spdx.xml
YAML *.spdx.yaml or *.spdx.yml

According to https://spdx.github.io/spdx-spec/v2.3/conformance/#44-standard-data-format-requirements it "should be easy to recognize in a file system without opening the file."

Will the naming convention be the same for SPDX v3?

Or do we like to have something like *.spdx3.* to differentiate the version?

Currently, Example 13 in spdx-examples repo uses example13.spdx3.json

This may appear in "Serialization" chapter of standard.

@bact
Copy link
Collaborator Author

bact commented Jul 23, 2024

From Outreach meeting 2024-07-22, OMG needs that a file should have only one extension (i.e. *.spdx or *.json, but not *.spdx.json)

@bact
Copy link
Collaborator Author

bact commented Jul 27, 2024

In 3.0.1, suggested name will be in "5.12 Standard data format requirements" subsection of Conformance chapter
#1002

@kestewart
Copy link
Contributor

This information has been removed from Conformance chapter - so keeping this open until we handle serialization and documentation.

@kestewart kestewart added this to the 3.0.1 milestone Aug 11, 2024
@goneall
Copy link
Member

goneall commented Aug 27, 2024

Suggestion is to add to the https://github.com/spdx/spdx-spec/blob/development/v3.0.1/docs/serializations.md page.

We can move this to 3.1 to allow for more time to discuss.

@goneall goneall modified the milestones: 3.0.1, 3.1 Aug 27, 2024
@zvr
Copy link
Member

zvr commented Aug 28, 2024

I also vote to leave it unspecified for now, and at some point in the future (3.1?) come up with all the corresponding entries (filenames, media types, etc.)

@bact
Copy link
Collaborator Author

bact commented Sep 26, 2024

@bact
Copy link
Collaborator Author

bact commented Oct 1, 2024

https://www.iana.org/assignments/media-types/application/spdx+json

has a file extension as .spdx.json

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants