SCP-49 Adds GH Check on main workflow

.github/workflows/test-action.yml

@@ -4,7 +4,7 @@ on:
   pull_request:
   push:
     branches:
-      - main
+      - '*'
 
 permissions:
   contents: read
@@ -14,7 +14,7 @@ jobs:
     name: GitHub Actions Test
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
 
     steps:

package.json

@@ -67,7 +67,8 @@
   },
   "dependencies": {
     "@actions/core": "^1.10.1",
-    "@actions/exec": "^1.1.1"
+    "@actions/exec": "^1.1.1",
+    "@actions/github": "^6.0.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.11",

src/app.config.ts

@@ -0,0 +1 @@
+export const CHECK_NAME = 'SCANOSS Policy Checker'

src/libs/GitHubCheck.ts

@@ -0,0 +1,55 @@
+import { context, getOctokit } from '@actions/github'
+import { getInput } from '@actions/core'
+
+const NO_INITIALIZATE = -1
+
+export class GitHubCheck {
+  private octokit // TODO: type from actions/github ?
+
+  private checkName: string
+
+  private checkRunId: number
+
+  constructor(checkName: string) {
+    const GITHUB_TOKEN = getInput('github-token') // TODO: move to inputs.ts file?
+
+    this.octokit = getOctokit(GITHUB_TOKEN)
+    this.checkName = checkName
+    this.checkRunId = NO_INITIALIZATE
+  }
+
+  async present() {
+    const result = await this.octokit.rest.checks.create({
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      name: this.checkName,
+      head_sha: context.sha
+    })
+
+    this.checkRunId = result.data.id
+
+    return result.data
+  }
+
+  async finish(conclusion: any, summary: string, text: string) {
+    if (this.checkRunId === NO_INITIALIZATE)
+      throw new Error(
+        `Error on finish. Check "${this.checkName}" is not created.`
+      )
+
+    const result = await this.octokit.rest.checks.update({
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      check_run_id: this.checkRunId,
+      status: 'completed',
+      conclusion,
+      output: {
+        title: this.checkName,
+        summary,
+        text
+      }
+    })
+
+    return result.data
+  }
+}

src/main.ts

@@ -1,5 +1,7 @@
 import * as core from '@actions/core'
 import * as exec from '@actions/exec'
+import { CHECK_NAME } from './app.config'
+import { GitHubCheck } from './libs/GitHubCheck'
 
 /**
  * The main function for the action.
@@ -12,6 +14,10 @@ export async function run(): Promise<void> {
     const repoDir = process.env.GITHUB_WORKSPACE as string
     const outputPath = 'results.json'
 
+    // init check
+    const check = new GitHubCheck(CHECK_NAME)
+    await check.present()
+
     // Declara las opciones para ejecutar el exec
     const options: exec.ExecOptions = {}
     let output: string = ''
@@ -29,6 +35,13 @@ export async function run(): Promise<void> {
       options
     )
 
+    // finish
+    await check.finish(
+      'success',
+      'Code analysis completed successfully',
+      'Here are the licenses found:'
+    )
+
     // set outputs for other workflow steps to use
     core.setOutput('result-filepath', outputPath)
   } catch (error) {