Skip to content

Commit a211a46

Browse files
committed
chore(report): SPDX Expression weeks 1, 2, 3 & 4 reports
1 parent 9886084 commit a211a46

12 files changed

+186
-0
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: Week 1
3+
author: Akash Sah
4+
tags: [gsoc24, spdx-expression]
5+
---
6+
7+
<!--
8+
SPDX-License-Identifier: CC-BY-SA-4.0
9+
10+
SPDX-FileCopyrightText: 2024 Akash Sah <akashsah2003@gmail.com>
11+
-->
12+
13+
# Week 1 meeting and activities
14+
15+
_(May 28,2024)_
16+
17+
## Attendees:
18+
19+
- [Akash Sah](https://github.com/Akashsah2003)
20+
- [Gaurav Mishra](https://github.com/GMishx)
21+
- [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
22+
- [Dearsh Oberoi](https://github.com/deo002)
23+
- [Abhishek Kumar](https://github.com/abhi-kumar17871)
24+
25+
## Discussions
26+
27+
### Prototype Presentation
28+
29+
- Presented a prototype for scanning expressions with OJO.
30+
- Initially, I was storing expressions directly as strings.
31+
- Received feedback that storing expressions as strings could not allow modifications.
32+
- Recieved suggestion to store license names as their references (licenseId) and the relationships between them (operators).
33+
34+
### Schema Proposal
35+
36+
- Was asked to propose a schema for storing license expressions.
37+
- Inquired if using a graph database like Neo4j would be suitable.
38+
- It was considered a good idea but mentors suggested not to use it as mixing two databases (PostgreSQL and Neo4j) would complicate things.
39+
40+
41+
## Activities
42+
43+
- Researched various methods to store license expressions.
44+
- Found that an Abstract Syntax Tree (AST) is a good way to store expressions.
45+
- Proposed two types of [schema](https://docs.google.com/document/d/1xYONSMBMQsLsGG3IIHD0gwJA0OP2-xPecLIaisIvupM/edit?usp=sharing) for storing license expressions.
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Week 2
3+
author: Akash Sah
4+
tags: [gsoc24, spdx-expression]
5+
---
6+
7+
<!--
8+
SPDX-License-Identifier: CC-BY-SA-4.0
9+
10+
SPDX-FileCopyrightText: 2024 Akash Sah <akashsah2003@gmail.com>
11+
-->
12+
13+
# Week 2 Meeting and Activities
14+
15+
_(June 4, 2024)_
16+
17+
## Attendees:
18+
19+
- [Akash Sah](https://github.com/Akashsah2003)
20+
- [Gaurav Mishra](https://github.com/GMishx)
21+
- [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
22+
- [Dearsh Oberoi](https://github.com/deo002)
23+
- [Abhishek Kumar](https://github.com/abhi-kumar17871)
24+
25+
## Discussions
26+
27+
### Schema Presentation
28+
29+
- Presented the two schemas for storing license expressions.
30+
- Mentors suggested that storing AST in JSONB was the better idea and to move forward with it.
31+
32+
## Activities
33+
34+
- Modified the OJO code base to scan expressions using regex and store expressions as AST in the database.
35+
- Worked on creating UI components to display and edit expressions.
36+
37+
## ScreenShots
38+
### License Expression Table
39+
![License Expression Table](/img/spdx-expression/licenseExpressionTable.png)
40+
### License Expression Schema
41+
![License Expression Schema](/img/spdx-expression/licenseExpressionSchema.png)
42+
### Edit Expression Modal
43+
![Edit Expression Modal](/img/spdx-expression/editExpressionModal.png)
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: Week 3
3+
author: Akash Sah
4+
tags: [gsoc24, spdx-expression]
5+
---
6+
7+
<!--
8+
SPDX-License-Identifier: CC-BY-SA-4.0
9+
10+
SPDX-FileCopyrightText: 2024 Akash Sah <akashsah2003@gmail.com>
11+
-->
12+
13+
# Week 3 Meeting and Activities
14+
15+
_(June 11, 2024)_
16+
17+
## Attendees:
18+
19+
- [Akash Sah](https://github.com/Akashsah2003)
20+
- [Gaurav Mishra](https://github.com/GMishx)
21+
- [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
22+
- [Dearsh Oberoi](https://github.com/deo002)
23+
- [Abhishek Kumar](https://github.com/abhi-kumar17871)
24+
25+
## Discussions
26+
27+
### Presentation of Work
28+
29+
- Presented my work on storing and displaying expressions.
30+
- Initially, expressions were displayed as a separate table in the UI.
31+
- Feedback: Expressions should be displayed in the same table as licenses.
32+
- When changing the license of a license expression, only detected licenses should be shown as options, rather than showing all licenses.
33+
- Inquired about how to store License Text, Acknowledgement, and Comments for licenses that are part of a license expression.
34+
- I proposed storing these in the AST as properties of the node.
35+
- Currently, they are stored in the `clearing_event` table.
36+
- Suggestion: Storing them in `clearing_event` is a good idea as it can serve as an audit log to track changes.
37+
- There should be a way for users to create an expression for a particular file with no existing expression.
38+
39+
## Activities
40+
41+
- Displayed license expressions in the same table as licenses.
42+
43+
### License Expressions in the Same Table
44+
![License Expressions in the Same Table](/img/spdx-expression/licenseDecisionsTable.png)
45+
46+
- Allowed users to create an expression for a file with no detected expression.
47+
48+
### Create Expression for File with No Detected Expression
49+
![Create Expression for File with No Detected Expression](/img/spdx-expression/userExpressionDecision.png)
50+
51+
- Allowed users to change the License Text, Acknowledgement, and Comment for licenses that are part of a license expression.
52+
53+
### Change License Text, Acknowledgement, and Comment
54+
![Change License Text, Acknowledgement, and Comment](/img/spdx-expression/customLicenseText.png)
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Week 4
3+
author: Akash Sah
4+
tags: [gsoc24, spdx-expression]
5+
---
6+
7+
<!--
8+
SPDX-License-Identifier: CC-BY-SA-4.0
9+
10+
SPDX-FileCopyrightText: 2024 Akash Sah <akashsah2003@gmail.com>
11+
-->
12+
13+
# Week 4 Meeting and Activities
14+
15+
_(June 18, 2024)_
16+
17+
## Attendees:
18+
19+
- [Akash Sah](https://github.com/Akashsah2003)
20+
- [Gaurav Mishra](https://github.com/GMishx)
21+
- [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
22+
- [Dearsh Oberoi](https://github.com/deo002)
23+
- [Abhishek Kumar](https://github.com/abhi-kumar17871)
24+
25+
## Discussions
26+
27+
### Presentation of UI Changes
28+
29+
- Presented the changes made in the UI.
30+
- Received feedback: Currently, it is not possible to add more than two licenses in a group within the license expression.
31+
- Recieved suggestion: The button for creating a license expression (if it does not exist) should be beside the user decision.
32+
- Informed the mentors that I will start working on the report generation part of the project.
33+
34+
## Activities
35+
36+
- Created functionality to allow licenses and groups to be added anywhere and option to remove license. Now, more than two licenses can be added to a group.
37+
38+
### Adding More Than Two Licenses in a Group
39+
![Adding More Than Two Licenses in a Group](/img/spdx-expression/addLicense.png)
40+
41+
### Removing a License in License Expression
42+
![Removing a License in License Expression](/img/spdx-expression/removeLicense.png)
43+
44+
- Started working on report generation for SPDX Tag Value and SPDX CSV.
186 KB
Loading
50.8 KB
Loading
Loading
Loading
Loading
Loading
184 KB
Loading
Loading

0 commit comments

Comments
 (0)