RD-970 Refine scan result files in artifact (#2)

* RD-970 Delete staticResult from artifact & rename finalResult file name

* RD-970 Update README.md and samples

* RD-970 Add SVG usage to README.md

---------

Co-authored-by: Clay Sang <[email protected]>

Author: chao-deepbits

README.md

@@ -47,13 +47,12 @@ jobs:
 
 ## Actions Artifact
 
-After the scan is complete, an artifact named `DEEPBITS_SCAN_RESULTS` will be generated, which contains three files:
+After the scan is complete, an artifact named `DEEPBITS_SCAN_RESULTS` will be generated, which contains two files:
 
-| Output              | Description                                                                     |
-| ------------------- | ------------------------------------------------------------------------------- |
-| sbom.CycloneDX.json | SBOM in CycloneDX format                                                        |
-| finalResult.json    | The final scan report contains vulnerability and malware summary in JSON format |
-| staticResult.json   | The static analysis report in JSON format                                       |
+| Output              | Description                                                           |
+| ------------------- | --------------------------------------------------------------------- |
+| sbom.CycloneDX.json | SBOM in CycloneDX format                                              |
+| scanSummary.json    | Scan result contains vulnerability and malware summary in JSON format |
 
 **We have included a sample folder called `sample_scan_results` in the repository [here](./samples/DEEPBITS_SCAN_RESULTS/).**
 
@@ -75,6 +74,20 @@ To obtain these outputs, please refer to the three options listed below:
 | DEEPBITS_COMMIT | The URL to access the scan report of the commit on DeepRepo |
 | DEEPBITS_BADGE  | A SVG badge displaying the status of the the repo           |
 
+You can add the SVG badge to your README.md file like this:
+
+```markdown
+[![SBOM status]({{DEEPBITS_BADGE}})]({{DEEPBITS_REPO}})
+```
+
+For example, the badge for this repository is:
+
+```markdown
+[![SBOM status](https://api.deepbits.com/gh/DeepBitsTechnology/getsbom/badge)](https://tools.deepbits.com/github/DeepBitsTechnology/getsbom)
+```
+
+[![SBOM status](https://api.deepbits.com/gh/DeepBitsTechnology/getsbom/badge)](https://tools.deepbits.com/github/DeepBitsTechnology/getsbom)
+
 **The image below is a screenshot of a scan result on [DeepRepo](https://tools.deepbits.com/github), which is accessible through the `DEEPBITS_COMMIT` output.**
 
 ![Scan result on DeepRepo](./samples/deeprepo_scan_screenshots.png)

__tests__/main.test.ts

@@ -31,7 +31,6 @@ describe('Main', () => {
         scanResult: [
           {
             finalResult: {bom: 'bom'},
-            staticResult: [{filePath: 'fp'}],
             scanEndAt: Date.now().toString(),
           },
         ],
@@ -43,8 +42,7 @@ describe('Main', () => {
       // Set up the expected artifact upload parameters
       const expectedUploadParams = [
         {name: 'sbom.CycloneDX', jsonContent: 'bom'},
-        {name: 'staticResult', jsonContent: [{filePath: 'fp'}]},
-        {name: 'finalResult', jsonContent: {bom: 'bom'}},
+        {name: 'scanSummary', jsonContent: {bom: 'bom'}},
       ];
 
       await run();
@@ -68,8 +66,7 @@ describe('Main', () => {
 
       const expectedUploadParams = [
         {name: 'sbom.CycloneDX', jsonContent: {}},
-        {name: 'staticResult', jsonContent: {}},
-        {name: 'finalResult', jsonContent: {}},
+        {name: 'scanSummary', jsonContent: {}},
       ];
 
       await run();

dist/index.js

@@ -17,12 +17,11 @@ export async function run(): Promise<void> {
 
     const scanResult = await getScanResult();
 
-    const {finalResult, staticResult} = scanResult?.scanResult?.[0] ?? {};
+    const {finalResult} = scanResult?.scanResult?.[0] ?? {};
 
     await uploadArtifacts([
       {name: 'sbom.CycloneDX', jsonContent: finalResult?.bom || {}},
-      {name: 'staticResult', jsonContent: staticResult || {}},
-      {name: 'finalResult', jsonContent: finalResult || {}},
+      {name: 'scanSummary', jsonContent: finalResult || {}},
     ]);
 
     await setInfo();