SCT-141 Changes PR report

scanoss · Feb 28, 2024 · f4e5a37 · f4e5a37
1 parent 33cd66b
commit f4e5a37
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 37 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/src/main.ts b/src/main.ts
@@ -1,6 +1,6 @@
 import { createCommentOnPR, isPullRequest } from './utils/github.utils';
 import { CopyleftPolicyCheck } from './policies/copyleft-policy-check';
-import { generateJobSummary, generateSummary } from './services/report.service';
+import { generateJobSummary, generatePRSummary } from './services/report.service';
 import * as core from '@actions/core';
 import * as inputs from './app.input';
 import * as outputs from './app.output';
@@ -35,7 +35,7 @@ export async function run(): Promise<void> {
 
     if (isPullRequest()) {
       // create reports
-      const report = generateSummary(scan);
+      const report = generatePRSummary(scan, policies);
       await createCommentOnPR(report);
     }
 

diff --git a/src/services/report.service.ts b/src/services/report.service.ts
@@ -1,29 +1,27 @@
 import { ScannerResults } from './result.interfaces';
-import { License, getLicenses } from './result.service';
+import { License, getComponents, getLicenses } from './result.service';
 import * as core from '@actions/core';
 import { CONCLUSION, PolicyCheck } from '../policies/policy-check';
 import { generateTable } from '../utils/markdown.utils';
-export function getLicensesTable(licenses: License[]): string {
-  let markdownTable = '| License | Copyleft | URL |\n';
-  markdownTable += '| ------- | -------- | --- |\n';
+import { context } from '@actions/github';
 
-  licenses.forEach(license => {
-    const copyleftIcon = license.copyleft ? ':x:' : ' ';
-    markdownTable += `| ${license.spdxid} | ${copyleftIcon} | ${license.url || ''} |\n`;
-  });
-
-  return markdownTable;
-}
-
-export function generateSummary(scannerResults: ScannerResults): string {
+export function generatePRSummary(scannerResults: ScannerResults, policies: PolicyCheck[]): string {
+  const components = getComponents(scannerResults);
   const licenses = getLicenses(scannerResults);
-  const licensesReport = getLicensesTable(licenses);
+
+  const polCount = {
+    total: policies.length,
+    success: policies.filter(p => p.conclusion === CONCLUSION.Success).length,
+    fail: policies.filter(p => p.conclusion !== CONCLUSION.Success).length
+  };
 
   const content = `
-  ## SCANOSS Summary :rocket:
-  ### Licenses detected: ${licenses.length}
+  ### SCANOSS SCAN Completed :rocket:
+  - **Components detected:** ${components.length}
+  - **Licenses detected:** ${licenses.length}
+  - **Policies:** ${polCount.fail ? `:x: ${polCount.fail} fail` : ''} ${polCount.success ? `:white_check_mark: ${polCount.success} pass` : ''} (${polCount.total} total)
 
-  ${licensesReport}
+  View more details on [SCANOSS Action Summary](${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId})
   `;
 
   return content;