Skip to content

Commit

Permalink
chore(report) : Add week 5 project report.
Browse files Browse the repository at this point in the history
Add tags to previous reports from week 1 to 4

Signed-off-by: Rajul Jha <rajuljha49@gmail.com>
  • Loading branch information
rajuljha committed Jul 4, 2024
1 parent 600d332 commit b1bdcee
Show file tree
Hide file tree
Showing 7 changed files with 58 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/2024/ci-scanner/updates/2024-06-06.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Week 1
author: Rajul Jha
tags: [gsoc24, CI]
---
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
Expand Down
1 change: 1 addition & 0 deletions docs/2024/ci-scanner/updates/2024-06-13.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Week 2
author: Rajul Jha
tags: [gsoc24, CI]
---
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
Expand Down
1 change: 1 addition & 0 deletions docs/2024/ci-scanner/updates/2024-06-20.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Week 3
author: Rajul Jha
tags: [gsoc24, CI]
---
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
Expand Down
3 changes: 2 additions & 1 deletion docs/2024/ci-scanner/updates/2024-06-27.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Week 4
author: Rajul Jha
tags: [gsoc24, CI]
---
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
Expand Down Expand Up @@ -32,7 +33,7 @@ SPDX-FileCopyrightText: 2024 Rajul Jha <rajuljha49gmail.com>

## Work Done

* Completed custom keyword functionality. [(#PR2769)](https://github.com/fossology/fossology/pull/2769) The details are as follows:
* Completed custom keyword functionality. [(#PR2769)](https://github.com/fossology/fossology/pull/2769)The details are as follows:
* User can now setup a GH Action or Gitlab CI pipeline and pass environment variables to scan for custom keywords however they want. This gives them immense control over what they wan't to scan.
* Added some validity checks for the `keyword.conf` file as during testing, I found out that the scanner breaks if an invalid file is passed to it.
* Set up a test docker image [(rjknightmare/fo-ci-test:latest)](https://hub.docker.com/layers/rjknightmare/fo-ci-test/latest/images/sha256-ac72768b8c4383a4aca05a50cd53ae427db9645b42619ad82b53e38b3b876b38?context=repo) for testing.
Expand Down
53 changes: 53 additions & 0 deletions docs/2024/ci-scanner/updates/2024-07-04.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Week 5
author: Rajul Jha
tags: [gsoc24, CI]
---
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2024 Rajul Jha <rajuljha49gmail.com>
-->

# Week 5
*(June 28, 2024 - July 04, 2024)*

## Meeting 1
*(July 03, 2024)*

## Attendees
* [Rajul Jha](https://github.com/rajuljha)
* [Gaurav](https://github.com/GMishx)
* [Kaushlendra](https://github.com/Kaushl2208)
* [Avinal Kumar](https://github.com/avinal)
* Katharina

## Discussions
* I showed my progress regarding differential scans and `allowlist` functionality.
* Discussed doubts regarding the nomos scanner `-J` flag. We'll tackle this later for now.
* Mentors mentioned that we should now work towards providing a `fossology action` which will
provide smooth integration into Github Actions.
* Created a new repository in fossology, called `fossology-action` for now.

## Work Done
* Researched and tested the relevant API endpoints from the Github and Gitab API's:
* Github API: `https://api.github.com/repos/:owner/:repo/compare/{:tag1}...{:tag2}`
![Screenshot](/img/ci/github_diff_payload.png)
* Gitlab API: `https://gitlab.com/api/v4/projects/:projectid/repository/compare/?from={:tag1}&to={:tag2}`
![Screenshot](/img/ci/gitlab_diff_payload.png)
* Implement differential scans and tested on Github and Gitlab and sent out a [PR(#2775)](https://github.com/fossology/fossology/pull/2775) for the same.
* Solved some bugs found in the previous [PR(#2574)](https://github.com/fossology/fossology/pull/2754#issuecomment-2196527812).
* Resolved and corrected some issues in [PR(#2754)](https://github.com/fossology/fossology/pull/2754) and [PR(#2769)](https://github.com/fossology/fossology/pull/2769) respectively.
* Started implementing the functionality that allows passing `allowlist.conf` file from a custom location
by the user.


## Planning for next week
* Complete the `allowlist.conf` part and send a PR for the same.
* Next, start researching and testing which type of Github Action we should create. Currently, there are three choices:
* **JavaScript Action**
* **Docker Action**
* **Composite Action**
* **Docker Action** and **Composite Action** are most *relevant* to our use case. Need to test and find out which is a better fit for us.
* Start working on providing and then releasing the action to the marketplace.
* PS: Also need to think about a cool name for the action :stuck_out_tongue_winking_eye:
Binary file added static/img/ci/github_diff_payload.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 static/img/ci/gitlab_diff_payload.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b1bdcee

Please sign in to comment.