spdx-spec icon indicating copy to clipboard operation
spdx-spec copied to clipboard

Suggested naming convention for SPDX v3 files

Open bact opened this issue 1 year ago • 7 comments

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 avatar Jul 10 '24 12:07 bact

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 avatar Jul 23 '24 00:07 bact

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

bact avatar Jul 27 '24 11:07 bact

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

kestewart avatar Aug 11 '24 21:08 kestewart

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 avatar Aug 27 '24 17:08 goneall

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.)

zvr avatar Aug 28 '24 18:08 zvr

  • Related: https://github.com/spdx/spdx-spec/issues/577

bact avatar Sep 26 '24 09:09 bact

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

has a file extension as .spdx.json

bact avatar Oct 01 '24 12:10 bact