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

chore(report): Support SPDX 3.0 week 6-12 #277

Merged
merged 1 commit into from
Sep 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/2024/spdx30/assets/Dual_License.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024/spdx30/assets/Package.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024/spdx30/assets/Person.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7,587 changes: 7,587 additions & 0 deletions docs/2024/spdx30/assets/SPDX3JSONLD_Twig-3.10.3.tar.gz_1724610670.jsonld

Large diffs are not rendered by default.

7,584 changes: 7,584 additions & 0 deletions docs/2024/spdx30/assets/SPDX3JSON_Twig-3.10.3.tar.gz_1724610654.json

Large diffs are not rendered by default.

6,426 changes: 6,426 additions & 0 deletions docs/2024/spdx30/assets/SPDX3RDF_Twig-3.10.3.tar.gz_1724610679.spdx.rdf

Large diffs are not rendered by default.

6,596 changes: 6,596 additions & 0 deletions docs/2024/spdx30/assets/SPDX3TV_Twig-3.10.3.tar.gz_1724610687.spdx

Large diffs are not rendered by default.

Binary file added docs/2024/spdx30/assets/annotation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024/spdx30/assets/anylicenseinfo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024/spdx30/assets/creationInfo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024/spdx30/assets/extractedlicenseinfo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024/spdx30/assets/file.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024/spdx30/assets/licenseinfoinfile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024/spdx30/assets/relationship.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024/spdx30/assets/spdx_document.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/2024/spdx30/assets/tool.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/2024/spdx30/updates/2024-05-28.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ SPDX-FileCopyrightText: 2024 Abhishek Kumar <[email protected]>

_(May 28,2024)_

## Attendees:
## Attendees

* [Abhishek Kumar](https://github.com/abhi-kumar17871)
* [Gaurav Mishra](https://github.com/GMishx)
Expand Down
20 changes: 18 additions & 2 deletions docs/2024/spdx30/updates/2024-06-04.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ SPDX-FileCopyrightText: 2024 Abhishek Kumar <[email protected]>

_(June 4, 2024)_

## Attendees:
## Attendees

* [Abhishek Kumar](https://github.com/abhi-kumar17871)
* [Gaurav Mishra](https://github.com/GMishx)
Expand All @@ -36,4 +36,20 @@ The [model image](../assets/model_Licensing.png) for the Licensing profile.
## Activities

* In this week, I continued to work on the SPDX v3.0 JSON-ld format report generation for Licensing profile.
* Made a [PR#2750](https://github.com/fossology/fossology/pull/2750) for Generation of SPDX v3.0 report in JSON format.
* Made a [PR#2750](https://github.com/fossology/fossology/pull/2750) for Generation of SPDX v3.0 report in JSON format.

## Sample Implementation of Core and Software Profile

Implemented the following use cases as required by the organization under Core and Software profile:
* ### Person
![Person](../assets/Person.png)
* ### Tool
![Tool](../assets/tool.png)
* ### File
![File](../assets/file.png)
* ### Package
![Package](../assets/Package.png)
* ### Relationship with Package containing Files
![Relationship with Package containing Files](../assets/relationship.png)
* ### SpdxDocument with Files
![SpdxDocument with Files](../assets/spdx_document.png)
2 changes: 1 addition & 1 deletion docs/2024/spdx30/updates/2024-06-11.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ SPDX-FileCopyrightText: 2024 Abhishek Kumar <[email protected]>

_(June 11, 2024)_

## Attendees:
## Attendees

* [Abhishek Kumar](https://github.com/abhi-kumar17871)
* [Gaurav Mishra](https://github.com/GMishx)
Expand Down
4 changes: 2 additions & 2 deletions docs/2024/spdx30/updates/2024-06-18.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ SPDX-FileCopyrightText: 2024 Abhishek Kumar <[email protected]>

_(June 18, 2024)_

## Attendees:
## Attendees

* [Abhishek Kumar](https://github.com/abhi-kumar17871)
* [Gaurav Mishra](https://github.com/GMishx)
Expand All @@ -23,7 +23,7 @@ _(June 18, 2024)_
## Discussions

* Have completed generation of SPDX v3.0 report in JSON format.
* Also discussed to the mentor about [validation of JSON-ld using JSON Schema, and SHACL Model](https://github.com/spdx/spdx-3-model/blob/main/serialization/json_ld/validation.md).
* Also discussed to the mentor about [validation of JSON-ld using JSON Schema, and SHACL Model](https://github.com/spdx/spdx-3-model/blob/main/serialization/jsonld/validation.md).
* We decided to follow the JSON Schema and SHACL Model for initial phase of validation.
* Next Step: Work on the validation of JSON-ld documents.

Expand Down
4 changes: 2 additions & 2 deletions docs/2024/spdx30/updates/2024-06-25.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ SPDX-FileCopyrightText: 2024 Abhishek Kumar <[email protected]>

_(June 25, 2024)_

## Attendees:
## Attendees

* [Abhishek Kumar](https://github.com/abhi-kumar17871)
* [Gaurav Mishra](https://github.com/GMishx)
Expand All @@ -22,7 +22,7 @@ _(June 25, 2024)_

## Discussions

* Presented my work SPDX v3.0 report in JSON and RDF format and also validated the reports using.
* Presented my work SPDX v3.0 report and also validated the reports using [validation of JSON-ld using JSON Schema, and SHACL Model](https://github.com/spdx/spdx-3-model/blob/main/serialization/jsonld/validation.md).
* Started resolving the issue while building the package in GitHub workflow.
* Next Step: Resolve the build issue and work on tag:value and CSV report generation.

Expand Down
38 changes: 38 additions & 0 deletions docs/2024/spdx30/updates/2024-07-02.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Week 6
author: Abhishek Kumar
tags: [gsoc24, spdx30]
---
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2024 Abhishek Kumar <[email protected]>
-->

# Week 6 meeting and activities

_(July 02,2024)_

## Attendees

* [Abhishek Kumar](https://github.com/abhi-kumar17871)
* [Gaurav Mishra](https://github.com/GMishx)
* [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
* [Dearsh Oberoi](https://github.com/deo002)
* [Akash Sah](https://github.com/Akashsah2003)

## Discussion

* Presented my work upon the tag:value report following the SPDX v3.0 JSON-ld report and previous SPDX v2.3 tag:value report.
* Also I discussed with [Gaurav Mishra](https://github.com/GMishx), regarding the Licensing Profile that are needed in the report and got a feedback that:
- Simple Licensing Profile will be sufficient to define the license text and license expression in the file.
- However, upon closer inspection for Expanded Licensing Profile, we need following fields as well:
- seeAlso
- ConjunctiveLicenseSet
- DisjunctiveLicenseSet
- NoneLicense
- NoAssertionLicense
* Next Step: Will be working on the suggested fields by the mentor for the Licensing profile.

## Activities

* Finished working on the tag:value report for Core and Software profile.
44 changes: 44 additions & 0 deletions docs/2024/spdx30/updates/2024-07-09.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Week 7
author: Abhishek Kumar
tags: [gsoc24, spdx30]
---
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2024 Abhishek Kumar <[email protected]>
-->

# Week 7 meeting and activities

_(July 09,2024)_

## Attendees

* [Abhishek Kumar](https://github.com/abhi-kumar17871)
* [Gaurav Mishra](https://github.com/GMishx)
* [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
* [Dearsh Oberoi](https://github.com/deo002)
* [Akash Sah](https://github.com/Akashsah2003)

## Discussion

* Updated on the Licensing Profile fields that were required for generation of the reports.
* Modified all the reports accordingly with the required fields.
* Got feedback from mentors to integrate the codebases of both the SPDX report i.e., v2.3 and v3.0 .
* Next Step: Will be working on the report-import of SPDX v3.0 RDF report and on integration as well.

## Activities

* Worked on the JSON-ld, JSON, RDF and tag: value reports for the Licensing Profile fields which were required.

## Sample Implementation of Licensing Profile

Implemented the following use cases as required by the organization under Licensing profile:
* ### Simple Licensing Any License Info: For all licenses
![simpleLicensing_AnyLicensingInfo](../assets/anylicenseinfo.png)
* ### Expanded Licensing Custom License: For Extracted License Info From File
![expandedLicensing_CustomLicense](../assets/extractedlicenseinfo.png)
* ### Expanded Licensing Conjunctive and Disjunctive Licensing Set: For Dual Licenses
![expandedLicensing_ConjunctiveLicenseSet](../assets/Dual_License.png)
* ### Annotation: For LicenseInfoFromFile and for LicenseInfoInFile
![Annotation](../assets/annotation.png)
40 changes: 40 additions & 0 deletions docs/2024/spdx30/updates/2024-07-16.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Week 8 & 9
author: Abhishek Kumar
tags: [gsoc24, spdx30]
---
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2024 Abhishek Kumar <[email protected]>
-->

# Week 8 & 9 meeting and activities

_(July 16,2024) & (July 23,2024)_

## Attendees

* [Abhishek Kumar](https://github.com/abhi-kumar17871)
* [Gaurav Mishra](https://github.com/GMishx)
* [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
* [Akash Sah](https://github.com/Akashsah2003)

## Discussion

* Updated on the report-import of SPDX v3.0 RDF report.
* Modified the RDF report accordingly for the proper ingestion of the report.
* Next Step: Will be working on the integration of the codebases of both the SPDX report.

## Activities

* Gone through the [EasyRDF package](https://www.easyrdf.org/docs) documentation, as this package will be used for proper ingestion of RDF report.
* Worked on the report-import of SPDX v3.0 RDF report.

## Sample Reports

* [Report in JSON-LD Format](../assets/SPDX3JSONLD_Twig-3.10.3.tar.gz_1724610670.jsonld)
* [Report in JSON Format](../assets/SPDX3JSON_Twig-3.10.3.tar.gz_1724610654.json)
* [Report in RDF Format](../assets/SPDX3RDF_Twig-3.10.3.tar.gz_1724610679.spdx.rdf)
* [Report in tag:value Format](../assets/SPDX3TV_Twig-3.10.3.tar.gz_1724610687.spdx)


29 changes: 29 additions & 0 deletions docs/2024/spdx30/updates/2024-07-30.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Week 10
author: Abhishek Kumar
tags: [gsoc24, spdx30]
---
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2024 Abhishek Kumar <[email protected]>
-->

# Week 10 meeting and activities

_(July 30,2024)_

## Attendees

* [Abhishek Kumar](https://github.com/abhi-kumar17871)
* [Gaurav Mishra](https://github.com/GMishx)
* [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
* [Akash Sah](https://github.com/Akashsah2003)

## Discussion

* Took guidance from [Gaurav Mishra](https://github.com/GMishx) regarding the files that are needed to be modified for the smooth integration of the codebases of both the SPDX report.

## Activities

* Worked on the guidelines given by mentors regarding the integration of codebases of both the SPDX reports.

30 changes: 30 additions & 0 deletions docs/2024/spdx30/updates/2024-08-06.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Week 11
author: Abhishek Kumar
tags: [gsoc24, spdx30]
---
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2024 Abhishek Kumar <[email protected]>
-->

# Week 11 meeting and activities

_(August 06,2024)_

## Attendees

* [Abhishek Kumar](https://github.com/abhi-kumar17871)
* [Gaurav Mishra](https://github.com/GMishx)
* [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
* [Akash Sah](https://github.com/Akashsah2003)

## Discussion

* The meeting was rescheduled as some members of the REST team and the SPDX team were unavailable.
* The new meeting time has been set for every Friday from 16:30 to 17:00 IST.

## Activities

* Continued working on the integration of the codebases of both the SPDX report i.e., v2.3 and v3.0 .

37 changes: 37 additions & 0 deletions docs/2024/spdx30/updates/2024-08-16.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Week 12
author: Abhishek Kumar
tags: [gsoc24, spdx30]
---
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2024 Abhishek Kumar <[email protected]>
-->

# Week 12 meeting and activities

_(August 16,2024)_

## Attendees

* [Abhishek Kumar](https://github.com/abhi-kumar17871)
* [Gaurav Mishra](https://github.com/GMishx)
* [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
* [Akash Sah](https://github.com/Akashsah2003)

## Discussion

* Updated on the integration of the codebase for the new SPDX v3.0 and previous SPDX v2.3.
* Completed the report-import support for the SPDX v3.0 RDF report.

## Activities

* Raised a final pull-request for the complete [feat(spdx): Support SPDX v3.0 Reports](https://github.com/fossology/fossology/pull/2813).

## References

Below are the GitHub repository and the SPDX Documentation link that helped me a lot in completion of this project.
* [SPDX 3 Model](https://github.com/spdx/spdx-3-model/tree/main)
* [SPDX 3 Serializtion Prototype Playground](https://github.com/spdx/spdx-3-serialization-prototype-playground/tree/main)
* [Differences between V3.0 and V2.3](https://spdx.github.io/spdx-spec/v3.0/annexes/diffs-from-previous-editions/)

2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ module.exports = {
to: '/docs/2024/license-detection',
},
{
label: 'SPDX 3.0 Support',
label: 'Support SPDX 3.0 Reports',
to: '/docs/2024/spdx30',
},
{
Expand Down