makefile

Author: rl-maartenb

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright GitHub
+Copyright ReversingLabs 2025
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

Makefile

@@ -0,0 +1,6 @@
+
+all:
+	npm run bundle
+
+test:
+	npm test

__tests__/main.test.ts

@@ -5,13 +5,13 @@
  * functions and objects. For example, the core module is mocked in this test,
  * so that the actual '@actions/core' module is not imported.
  */
+
 import { jest } from '@jest/globals'
 import * as core from '../__fixtures__/core.js'
 import { wait } from '../__fixtures__/wait.js'
 
 // Mocks should be declared before the module being tested is imported.
 jest.unstable_mockModule('@actions/core', () => core)
-jest.unstable_mockModule('../src/wait.js', () => ({ wait }))
 
 // The module being tested should be imported dynamically. This ensures that the
 // mocks are used in place of any actual dependencies.
@@ -20,7 +20,7 @@ const { run } = await import('../src/main.js')
 describe('main.ts', () => {
   beforeEach(() => {
     // Set the action's inputs as return values from core.getInput().
-    core.getInput.mockImplementation(() => '500')
+    core.getInput.mockImplementation(() => 'report.rl.json')
 
     // Mock the wait function so that it does not actually wait.
     wait.mockImplementation(() => Promise.resolve('done!'))
@@ -32,31 +32,5 @@ describe('main.ts', () => {
 
   it('Sets the time output', async () => {
     await run()
-
-    // Verify the time output was set.
-    expect(core.setOutput).toHaveBeenNthCalledWith(
-      1,
-      'time',
-      // Simple regex to match a time string in the format HH:MM:SS.
-      expect.stringMatching(/^\d{2}:\d{2}:\d{2}/)
-    )
-  })
-
-  it('Sets a failed status', async () => {
-    // Clear the getInput mock and return an invalid value.
-    core.getInput.mockClear().mockReturnValueOnce('this is not a number')
-
-    // Clear the wait mock and return a rejected promise.
-    wait
-      .mockClear()
-      .mockRejectedValueOnce(new Error('milliseconds is not a number'))
-
-    await run()
-
-    // Verify that the action was marked as failed.
-    expect(core.setFailed).toHaveBeenNthCalledWith(
-      1,
-      'milliseconds is not a number'
-    )
   })
 })

__tests__/wait.test.ts

@@ -1,23 +1,18 @@
-name: The name of your action here
-description: Provide a description here
-author: Your name or organization here
+name: rl-json-to-simple-feedback-markdown
+description:
+  Parse the report.rl.json file and produce a markdown simplefied summary
+author: ReversingLabs
 
 # Add your action's branding here. This will appear on the GitHub Marketplace.
 branding:
   icon: heart
-  color: red
+  color: purple
 
 # Define your inputs here.
 inputs:
-  milliseconds:
-    description: Your input description here
+  rl_json_path:
+    description: The path to the report.rl.json file.
     required: true
-    default: '1000'
-
-# Define your outputs here.
-outputs:
-  time:
-    description: Your output description here
 
 runs:
   using: node20

action.yml

@@ -11,23 +11,21 @@ import fs from 'fs'
  */
 export async function run(): Promise<void> {
   try {
-    // const ms: string = core.getInput('milliseconds')
-    const rl_json_file: string = core.getInput('rl_json_file')
+    const rl_json_file: string = core.getInput('rl_json_path')
     const data = JSON.parse(fs.readFileSync(rl_json_file, 'utf-8'))
     core.debug(`loaded json file ${rl_json_file}`)
     core.debug(new Date().toTimeString())
 
     const name: string = data.info.file.identity.name
     const purl: string = data.info.file.identity.purl
-    core.debug(`name: {name}, purl: {purl}`)
-
-    // data.info.file.identity {name, purl }
-    // data.report.metadata.assessments
+    core.debug(`name: ${name}, purl: ${purl}`)
 
     // Set outputs for other workflow steps to use
-    core.setOutput('time', new Date().toTimeString())
+    // core.setOutput('time', new Date().toTimeString())
   } catch (error) {
     // Fail the workflow run if an error occurs
-    if (error instanceof Error) core.setFailed(error.message)
+    if (error instanceof Error) {
+      core.setFailed(error.message)
+    }
   }
 }

dist/index.js

@@ -3,7 +3,8 @@
   "extends": "./tsconfig.base.json",
   "compilerOptions": {
     "allowJs": true,
-    "noEmit": true
+    "noEmit": true,
+    "isolatedModules": true
   },
   "exclude": ["dist", "node_modules"],
   "include": [