diff --git a/__tests__/report-service.test.ts b/__tests__/report-service.test.ts index 8f05ef5..8712f2c 100644 --- a/__tests__/report-service.test.ts +++ b/__tests__/report-service.test.ts @@ -1,4 +1,4 @@ -import { getLicensesReport } from '../src/services/report.service'; +import { getLicensesTable } from '../src/services/report.service'; const licenseTableTest = [ { @@ -32,7 +32,7 @@ const licenseTableTest = [ describe('Test report service', () => { for (const t of licenseTableTest) { it(`${t.name}`, () => { - const report = getLicensesReport(t.licenses); + const report = getLicensesTable(t.licenses); expect(report).toEqual(t.output); }); } diff --git a/dist/index.js b/dist/index.js index 39caa7f..2731fc1 100644 --- a/dist/index.js +++ b/dist/index.js @@ -30260,9 +30260,8 @@ async function run() { policies.forEach(async (policy) => await policy.run(scannerResults)); if ((0, github_utils_1.isPullRequest)()) { // create reports - const licenses = (0, result_service_1.getLicenses)(scannerResults); - const licensesReport = (0, report_service_1.getLicensesReport)(licenses); - (0, github_utils_1.createCommentOnPR)(licensesReport); + const report = (0, report_service_1.generateSummary)(scannerResults); + (0, github_utils_1.createCommentOnPR)(report); } // set outputs for other workflow steps to use core.setOutput(outputs.RESULT_FILEPATH, inputs.OUTPUT_PATH); @@ -30408,13 +30407,14 @@ exports.PolicyCheck = PolicyCheck; /***/ }), /***/ 2467: -/***/ ((__unused_webpack_module, exports) => { +/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => { "use strict"; Object.defineProperty(exports, "__esModule", ({ value: true })); -exports.getLicensesReport = void 0; -function getLicensesReport(licenses) { +exports.generateSummary = exports.getLicensesTable = void 0; +const result_service_1 = __nccwpck_require__(2414); +function getLicensesTable(licenses) { let markdownTable = '| License | Copyleft | URL |\n'; markdownTable += '| ------- | -------- | --- |\n'; licenses.forEach(license => { @@ -30423,7 +30423,19 @@ function getLicensesReport(licenses) { }); return markdownTable; } -exports.getLicensesReport = getLicensesReport; +exports.getLicensesTable = getLicensesTable; +function generateSummary(scannerResults) { + const licenses = (0, result_service_1.getLicenses)(scannerResults); + const licensesReport = getLicensesTable(licenses); + const content = ` + ## SCANOSS Summary :rocket: + ### Licenses detected: ${licenses.length} + + ${licensesReport} + `; + return content; +} +exports.generateSummary = generateSummary; /***/ }), diff --git a/src/main.ts b/src/main.ts index 77af53a..84feb84 100644 --- 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 { 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 index 91a91b2..836d407 100644 --- 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; +}