RD-1197 Migrate to platform architecture (#4)

Author: chao-deepbits

.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     outputs:
       SCAN_BADGE: ${{ steps.deepbits-scan.outputs.DEEPBITS_BADGE }}
-      DEEPBITS_LINK: ${{ steps.deepbits-scan.outputs.DEEPBITS_COMMIT }}
+      DEEPSCA_BRANCH_LINK: ${{ steps.deepbits-scan.outputs.DEEPSCA_BRANCH }}
     steps:
       - uses: actions/checkout@v3
 
@@ -35,7 +35,7 @@ jobs:
             ---
 
             Powered by [**Deepbits**](https://deepbits.com):
-            - Scan Details: ${{ needs.deepbits-scan.outputs.DEEPBITS_LINK }}
+            - Scan Details: ${{ needs.deepbits-scan.outputs.DEEPSCA_BRANCH_LINK }}
             - Badge: ${{ needs.deepbits-scan.outputs.SCAN_BADGE }}
 
   download-artifact:

README.md

@@ -38,8 +38,8 @@ jobs:
     runs-on: ubuntu-latest
     outputs:
       SCAN_BADGE: ${{ steps.deepbits-scan.outputs.DEEPBITS_BADGE }}
-      DEEPBITS_COMMIT_LINK: ${{ steps.deepbits-scan.outputs.DEEPBITS_COMMIT }}
-      DEEPBITS_REPO_LINK: ${{ steps.deepbits-scan.outputs.DEEPBITS_REPO }}
+      DEEPSCA_BRANCH_LINK: ${{ steps.deepbits-scan.outputs.DEEPSCA_BRANCH }}
+      DEEPSCA_REPO_LINK: ${{ steps.deepbits-scan.outputs.DEEPSCA_REPO }}
     steps:
       - uses: DeepBitsTechnology/getsbom@v1
         id: deepbits-scan
@@ -71,22 +71,22 @@ We hope that these examples will help you understand the capabilities of our act
 
 ## Actions Outputs
 
-In addition to the artifact, you may also view the scan results and your previous scan histories on [DeepRepo](https://tools.deepbits.com/github).
+In addition to the artifact, you may also view the scan results and your previous scan histories on [DeepSCA](https://tools.deepbits.com).
 
 Additionally, a SVG is available that can be included in your README file.
 
 To obtain these outputs, please refer to the three options listed below:
 
-| Output          | Description                                                 |
-| --------------- | ----------------------------------------------------------- |
-| DEEPBITS_REPO   | The URL to access the repo details of DeepRepo              |
-| 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           |
+| Output         | Description                                                |
+| -------------- | ---------------------------------------------------------- |
+| DEEPSCA_REPO   | The URL to access the repo details of DeepSCA              |
+| DEEPSCA_BRANCH | The URL to access the scan report of the branch on DeepSCA |
+| 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}})
+[![SBOM status]({{DEEPBITS_BADGE}})]({{DEEPSCA_REPO}})
 ```
 
 For example, the badge for this repository is:
@@ -97,11 +97,11 @@ For example, the badge for this repository is:
 
 [![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.**
+**The image below is a screenshot of a scan result on [DeepSCA](https://tools.deepbits.com), which is accessible through the `DEEPSCA_BRANCH` output.**
 
-![Scan result on DeepRepo](./samples/deeprepo_scan_screenshots.png)
+![Scan result on DeepSCA](./samples/deeprepo_scan_screenshots.png)
 
-The scan results displayed in DeepRepo are interactive and allow you to view detailed information about the components used in your project, as well as any vulnerabilities or licensing issues detected during the scan.
+The scan results displayed in DeepSCA are interactive and allow you to view detailed information about the components used in your project, as well as any vulnerabilities or licensing issues detected during the scan.
 
 Click [this URL](https://tools.deepbits.com/github/DeepBitsTechnology/getsbom/d29263777ef33157254ff4207ca00cedf0d537e1) to see the comprehensive view of the screenshot results.
 

dist/index.js

@@ -1,22 +1,38 @@
 import * as core from '@actions/core';
 import {
   downloadCommitSbomZip,
+  getBranchName,
   getScanResult,
+  isProperEvent,
   isRepoPublic,
   setInfo,
   uploadArtifacts,
 } from './utils/DeepbitsGitHubAction';
 
 export async function run(): Promise<void> {
   try {
+    if (!(await isProperEvent())) {
+      core.setFailed(
+        'This action is available for branch push only at the moment.'
+      );
+      return;
+    }
+
     const isPublic = await isRepoPublic();
 
     if (!isPublic) {
-      core.setFailed('Private repositories are not supported');
+      core.setFailed('Private repositories are not supported.');
+      return;
+    }
+
+    const branchName = getBranchName();
+
+    if (!branchName) {
+      core.setFailed('Branch name is not available.');
       return;
     }
 
-    const scanResult = (await getScanResult())?.scanResult?.[0];
+    const scanResult = (await getScanResult(branchName))?.scanResult;
 
     let sbomZipFileLocation: string | undefined;
 
@@ -31,7 +47,7 @@ export async function run(): Promise<void> {
       sbomZipFileLocation ? [sbomZipFileLocation] : undefined
     );
 
-    await setInfo();
+    await setInfo(branchName);
   } catch (error) {
     if (error instanceof Error) core.setFailed(error.message);
   }

dist/index.js.map

@@ -37,9 +37,8 @@ export type ScanResult = {
   sbomResult?: SBOMInfo[];
 };
 
-export type GitHubCommitDefWithPopulatedScanResult = Omit<
-  GitHubCommitDef,
-  'scanResult'
-> & {
-  scanResult?: ScanResult[];
-};
+export interface ScanResultResponse {
+  scanResult?: ScanResult;
+  resourceMetaData?: any; // TODO: Feature Roadmap
+  sbomStream?: any; // TODO: Feature Roadmap
+}

src/main.ts

@@ -7,6 +7,12 @@ import {BASE_URL, TOOLS_URL, getCommitResultUntilScanEnds} from './api';
 
 const ROOT_DIRECTORY_NAME = 'DEEPBITS_SCAN_RESULTS';
 
+export const isProperEvent = async (): Promise<boolean> => {
+  const eventName = github.context.eventName;
+
+  return eventName === 'push';
+};
+
 export const isRepoPublic = async (): Promise<boolean> => {
   const token = core.getInput('token');
   const context = github.context;
@@ -20,31 +26,46 @@ export const isRepoPublic = async (): Promise<boolean> => {
   return !data.private;
 };
 
-export const getScanResult = async () => {
+export const getBranchName = () => {
+  const context = github.context;
+
+  const {ref} = context;
+  const prHeadRef = process.env.GITHUB_HEAD_REF;
+
+  return github.context.eventName === 'pull_request'
+    ? prHeadRef
+    : ref.replace('refs/heads/', '');
+};
+
+export const getScanResult = async (branchName: string) => {
   const context = github.context;
 
   const {sha} = context;
   const {owner, repo} = context.repo;
 
-  const result = await getCommitResultUntilScanEnds({owner, repo, sha});
+  const result = await getCommitResultUntilScanEnds({
+    owner,
+    repo,
+    branchName,
+    sha,
+  });
 
   return result;
 };
 
-export const setInfo = async () => {
+export const setInfo = async (branchName: string) => {
   const context = github.context;
 
-  const {sha} = context;
   const {owner, repo} = context.repo;
 
   const infoList = [
     {
-      name: 'DEEPBITS_REPO',
+      name: 'DEEPSCA_REPO',
       value: `${TOOLS_URL}/${owner}/${repo}`,
     },
     {
-      name: 'DEEPBITS_COMMIT',
-      value: `${TOOLS_URL}/${owner}/${repo}/${sha}`,
+      name: 'DEEPSCA_BRANCH',
+      value: `${TOOLS_URL}/${owner}/${repo}/${branchName}`,
     },
     {
       name: 'DEEPBITS_BADGE',