CR

Author: EyalDelarea

lib/cleanup.js

@@ -34,7 +34,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const core = __importStar(require("@actions/core"));
 const utils_1 = require("./utils");
-const job_summary_utils_1 = require("./job-summary-utils");
+const job_summary_1 = require("./job-summary");
 function cleanup() {
     return __awaiter(this, void 0, void 0, function* () {
         if (yield shouldSkipCleanup()) {
@@ -67,7 +67,7 @@ function cleanup() {
 function buildInfoPostTasks() {
     return __awaiter(this, void 0, void 0, function* () {
         const disableAutoBuildPublish = core.getBooleanInput(utils_1.Utils.AUTO_BUILD_PUBLISH_DISABLE);
-        const disableJobSummary = core.getBooleanInput(utils_1.Utils.JOB_SUMMARY_DISABLE) || !job_summary_utils_1.JobSummaryUtils.isJobSummarySupported();
+        const disableJobSummary = core.getBooleanInput(utils_1.Utils.JOB_SUMMARY_DISABLE) || !job_summary_1.JobSummary.isJobSummarySupported();
         if (disableAutoBuildPublish && disableJobSummary) {
             core.info(`Both auto-build-publish and job-summary are disabled. Skipping Build Info post tasks.`);
             return;
@@ -95,11 +95,11 @@ function buildInfoPostTasks() {
 function hasUnpublishedModules(workingDirectory) {
     return __awaiter(this, void 0, void 0, function* () {
         // Save the old value of the environment variable to revert it later
-        const origValue = process.env[job_summary_utils_1.JobSummaryUtils.JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR_ENV];
+        const origValue = process.env[job_summary_1.JobSummary.JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR_ENV];
         try {
             core.startGroup('Check for unpublished modules');
             // Avoid saving a command summary for this dry-run command
-            core.exportVariable(job_summary_utils_1.JobSummaryUtils.JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR_ENV, '');
+            core.exportVariable(job_summary_1.JobSummary.JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR_ENV, '');
             // Running build-publish command with a dry-run flag to check if there are any unpublished modules, 'silent' to avoid polluting the logs
             const responseStr = yield utils_1.Utils.runCliAndGetOutput(['rt', 'build-publish', '--dry-run'], { cwd: workingDirectory });
             // Parse the JSON string to an object
@@ -112,7 +112,7 @@ function hasUnpublishedModules(workingDirectory) {
             return false;
         }
         finally {
-            core.exportVariable(job_summary_utils_1.JobSummaryUtils.JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR_ENV, origValue);
+            core.exportVariable(job_summary_1.JobSummary.JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR_ENV, origValue);
             core.endGroup();
         }
     });
@@ -185,10 +185,10 @@ function generateJobSummary() {
         try {
             core.startGroup('Generating Job Summary');
             yield utils_1.Utils.runCli(['generate-summary-markdown']);
-            yield job_summary_utils_1.JobSummaryUtils.setMarkdownAsJobSummary();
-            yield job_summary_utils_1.JobSummaryUtils.populateCodeScanningTab();
+            yield job_summary_1.JobSummary.setMarkdownAsJobSummary();
+            yield job_summary_1.JobSummary.populateCodeScanningTab();
             // Clear files
-            yield job_summary_utils_1.JobSummaryUtils.clearCommandSummaryDir();
+            yield job_summary_1.JobSummary.clearCommandSummaryDir();
         }
         catch (error) {
             core.warning('Failed while attempting to generate job summary: ' + error);

lib/job-summary-utils.js lib/job-summary.jslib/job-summary-utils.js renamed to lib/job-summary.js

@@ -35,7 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.JobSummaryUtils = void 0;
+exports.JobSummary = void 0;
 const core = __importStar(require("@actions/core"));
 const semver_1 = require("semver");
 const core_1 = require("@octokit/core");
@@ -47,7 +47,7 @@ const fs_1 = require("fs");
 const http_client_1 = require("@actions/http-client");
 const os_1 = require("os");
 const utils_1 = require("./utils");
-class JobSummaryUtils {
+class JobSummary {
     /**
      * Enabling job summary is done by setting the output dir for the summaries.
      * If the output dir is not set, the CLI won't generate the summary Markdown files.
@@ -308,35 +308,35 @@ class JobSummaryUtils {
         return process.env.GITHUB_WORKFLOW || '';
     }
 }
-exports.JobSummaryUtils = JobSummaryUtils;
+exports.JobSummary = JobSummary;
 // Directory name which holds markdown files for the Workflow summary
-JobSummaryUtils.JOB_SUMMARY_DIR_NAME = 'jfrog-command-summary';
+JobSummary.JOB_SUMMARY_DIR_NAME = 'jfrog-command-summary';
 // Directory name which holds security command summary files
-JobSummaryUtils.SECURITY_DIR_NAME = 'security';
+JobSummary.SECURITY_DIR_NAME = 'security';
 // Directory name which holds sarifs files for the code scanning tab
-JobSummaryUtils.SARIF_REPORTS_DIR_NAME = 'sarif-reports';
+JobSummary.SARIF_REPORTS_DIR_NAME = 'sarif-reports';
 // JFrog CLI command summary output directory environment variable
-JobSummaryUtils.JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR_ENV = 'JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR';
+JobSummary.JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR_ENV = 'JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR';
 // Minimum JFrog CLI version supported for job summary command
-JobSummaryUtils.MIN_CLI_VERSION_JOB_SUMMARY = '2.66.0';
+JobSummary.MIN_CLI_VERSION_JOB_SUMMARY = '2.66.0';
 // Code scanning sarif expected file extension.
-JobSummaryUtils.CODE_SCANNING_FINAL_SARIF_FILE = 'final.sarif';
+JobSummary.CODE_SCANNING_FINAL_SARIF_FILE = 'final.sarif';
 // URL for the markdown header image
 // This is hosted statically because its usage is outside the context of the JFrog setup action.
 // It cannot be linked to the repository, as GitHub serves the image from a CDN,
 // which gets blocked by the browser, resulting in an empty image.
-JobSummaryUtils.MARKDOWN_HEADER_PNG_URL = 'https://media.jfrog.com/wp-content/uploads/2024/09/02161430/jfrog-job-summary.svg';
+JobSummary.MARKDOWN_HEADER_PNG_URL = 'https://media.jfrog.com/wp-content/uploads/2024/09/02161430/jfrog-job-summary.svg';
 // Flag to indicate if the summary header is accessible, can be undefined if not checked yet.
-JobSummaryUtils.isSummaryHeaderAccessible = undefined;
+JobSummary.isSummaryHeaderAccessible = undefined;
 // Job ID query parameter key
-JobSummaryUtils.JOB_ID_PARAM_KEY = 'job_id';
+JobSummary.JOB_ID_PARAM_KEY = 'job_id';
 // Run ID query parameter key
-JobSummaryUtils.RUN_ID_PARAM_KEY = 'run_id';
+JobSummary.RUN_ID_PARAM_KEY = 'run_id';
 // Git repository query parameter key
-JobSummaryUtils.GIT_REPO_PARAM_KEY = 'git_repo';
+JobSummary.GIT_REPO_PARAM_KEY = 'git_repo';
 // Source query parameter indicating the source of the request
-JobSummaryUtils.SOURCE_PARAM_KEY = 's';
-JobSummaryUtils.SOURCE_PARAM_VALUE = '1';
+JobSummary.SOURCE_PARAM_KEY = 's';
+JobSummary.SOURCE_PARAM_VALUE = '1';
 // Metric query parameter indicating the metric type
-JobSummaryUtils.METRIC_PARAM_KEY = 'm';
-JobSummaryUtils.METRIC_PARAM_VALUE = '1';
+JobSummary.METRIC_PARAM_KEY = 'm';
+JobSummary.METRIC_PARAM_VALUE = '1';