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 the generated RDF files #1067

Merged
merged 5 commits into from
Aug 18, 2024
Merged

Add the generated RDF files #1067

merged 5 commits into from
Aug 18, 2024

Conversation

zvr
Copy link
Member

@zvr zvr commented Aug 13, 2024

We used to have a top-level directory ontology in this repo, containing the RDF data. It was removed because it was stale.

This PR adds this data back, in a new top-level directory named rdf.

This includes the ontology, but also the JSON-LD context file.

Signed-off-by: Alexios Zavras github@zvr.gr

Signed-off-by: Alexios Zavras <github@zvr.gr>
Copy link

@bobmartin3000 bobmartin3000 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@bact bact left a comment

Choose a reason for hiding this comment

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

Does it possible to take this opportunity that the URL is going to change anyway (because of the patch version update), to have this file rdf/spdx-model.json-ld renamed to rdf/spdx-model.jsonld please?

The reason is, with that we can have the extension that is consistent with rdf/spdx-context.jsonld and authors will not have to remember when to use .json-ld or when to use .jsonld.

I have checked in both spdx-spec and spdx-3-model repos,

  • there are at least 25 instances of spdx-context.jsonld
  • there's only one instance of spdx-model.json-ld, which is in the README section, and not the spec or the code:

    spdx-spec/README.md

    Lines 156 to 162 in 399bbf5

    This will create well-formatted model files in the `spdx-spec/docs/model/`
    directory. This directory contains two components:
    - Model ontology and diagram files: These files (`model.plantuml`,
    `spdx-context.jsonld`, `spdx-model.dot`, `spdx-model.json-ld`,
    `spdx-model.pretty-xml`, `spdx-model.ttl`, `spdx-model.xml`)
    are ready for immediate use.

    Current instances that reference to the SPDX model use spdx-model.ttl.

This means the change to standardize .jsonld will not be a breaking one.

Thank you for generating and adding these files back.

@zvr
Copy link
Member Author

zvr commented Aug 13, 2024

Of course the filename can easily be changed, but let's be careful here:
we do not want to encourage people using these files automatically from the repo.

The idea is to simply have them for people to view (most probably via the GitHub web UI). It should not be considered a distribution mechanism of generated artifacts.
(we have had this problem before)

@bact
Copy link
Collaborator

bact commented Aug 13, 2024

Thanks. +1 on "It should not be considered a distribution mechanism of generated artifacts."

I think in general, some consistency/common expectability will help us the developers as well, not only the "end-users".

@kestewart kestewart added this to the 3.0.1 milestone Aug 14, 2024
@zvr
Copy link
Member Author

zvr commented Aug 17, 2024

I've now added all the various formats that RDF data can be automatically generated.

@zvr zvr requested a review from bact August 17, 2024 09:54
@bact
Copy link
Collaborator

bact commented Aug 18, 2024

Thank you. I think we can merge this.

@bact bact merged commit c0326b1 into spdx:development/v3.0.1 Aug 18, 2024
2 checks passed
@zvr zvr deleted the rdf branch September 6, 2024 08:31
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.

4 participants