SCP-75 Adds summary on PR

scanoss · Jan 25, 2024 · f5646c1 · f5646c1
1 parent 9842d94
commit f5646c1
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 13 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/src/main.ts b/src/main.ts
@@ -1,7 +1,7 @@
 import { getLicenses, readResult } from './services/result.service';
 import { createCommentOnPR, isPullRequest } from './utils/github.utils';
 import { CopyleftPolicyCheck } from './policies/copyleft-policy-check';
-import { getLicensesReport } from './services/report.service';
+import { generateSummary, getLicensesTable } from './services/report.service';
 import * as core from '@actions/core';
 import * as exec from '@actions/exec';
 import * as inputs from './app.input';
@@ -30,9 +30,8 @@ export async function run(): Promise<void> {
 
     if (isPullRequest()) {
       // create reports
-      const licenses = getLicenses(scannerResults);
-      const licensesReport = getLicensesReport(licenses);
-      createCommentOnPR(licensesReport);
+      const report = generateSummary(scannerResults);
+      createCommentOnPR(report);
     }
 
     // set outputs for other workflow steps to use

diff --git a/src/services/report.service.ts b/src/services/report.service.ts
@@ -1,6 +1,7 @@
-import { Licenses } from './result.service';
+import { ScannerResults } from './result.interfaces';
+import { Licenses, getLicenses } from './result.service';
 
-export function getLicensesReport(licenses: Licenses[]): string {
+export function getLicensesTable(licenses: Licenses[]): string {
   let markdownTable = '| License | Copyleft | URL |\n';
   markdownTable += '| ------- | -------- | --- |\n';
 
@@ -11,3 +12,17 @@ export function getLicensesReport(licenses: Licenses[]): string {
 
   return markdownTable;
 }
+
+export function generateSummary(scannerResults: ScannerResults): string {
+  const licenses = getLicenses(scannerResults);
+  const licensesReport = getLicensesTable(licenses);
+
+  const content = `
+  ## SCANOSS Summary :rocket:
+  ### Licenses detected: ${licenses.length}
+
+  ${licensesReport}
+  `;
+
+  return content;
+}