Godeepakm/add project flag (#31)

* add prpject flag * add prpject flagcd * Build app * Add test for scanning with a --project option. * Run fossa test correctly. Oops. --------- Co-authored-by: root <[email protected]> Co-authored-by: Chelsea Boling <[email protected]> Co-authored-by: Christopher Sasarak <[email protected]>
fossas · Feb 15, 2024 · 47ef11b · 47ef11b
1 parent 32c7979
commit 47ef11b
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 3 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -53,6 +53,14 @@ jobs:
         with:
           api-key: ${{secrets.fossaApiKey}}
           branch: develop
+          project: custom-test-project
+
+      - name: Run FOSSA test with a --project and --branch
+        uses: ./
+        with:
+          api-key: ${{secrets.fossaApiKey}}
+          branch: develop
+          project: custom-test-project
 
       - name: Run FOSSA test
         uses: ./

diff --git a/README.md b/README.md
@@ -86,6 +86,23 @@ jobs:
           branch: some-feature-branch
 ```
 
+### `project`
+
+**Optional** Project flag passed to FOSSA CLI.
+
+Example
+```yml
+jobs:
+  fossa-scan:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: fossas/fossa-action@main # Use a specific version if locking is preferred
+        with:
+          api-key: ${{secrets.fossaApiKey}}
+          project: some-project-name
+```
+
 ### `endpoint`
 
 **Optional** Endpoint passed to FOSSA CLI. Defaults to `app.fossa.com`. [Read more](https://github.com/fossas/spectrometer/blob/master/docs/userguide.md#common-fossa-project-flags).
@@ -144,7 +161,7 @@ jobs:
 ```
 
 ### Running tests
-This run `fossa tests` after doing an initial scan.
+This runs `fossa tests` after doing an initial scan.
 
 ```yml
 jobs:

diff --git a/action.yml b/action.yml
@@ -24,6 +24,11 @@ inputs:
       Override the detected FOSSA project branch. If running FOSSA analysis on a
       Pull Request, as a start you can use the contexts `github.ref` or `github.ref_name`.
     required: false
+  project:
+    description: >-
+      Override the detected FOSSA project name. If running FOSSA analysis on a
+      Pull Request, as a start you can use the contexts `github.ref` or `github.ref_name`.
+    required: false
   debug:
     description: >-
       Run all FOSSA commands in debug mode. Running `fossa analyze` in debug

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/config.ts b/src/config.ts
@@ -12,4 +12,5 @@ export const CONTAINER = getInput('container', getInputOptions());
 export const RUN_TESTS = getBooleanInput('run-tests', {required: false});
 export const ENDPOINT = getInput('endpoint', getInputOptions());
 export const BRANCH = getInput('branch', getInputOptions());
+export const PROJECT = getInput('project', getInputOptions());
 export const DEBUG = getBooleanInput('debug', {required: false});
diff --git a/src/index.ts b/src/index.ts
@@ -6,6 +6,7 @@ import {
   RUN_TESTS,
   ENDPOINT,
   BRANCH,
+  PROJECT,
   DEBUG,
 } from './config';
 import { fetchFossaCli } from './download-cli';
@@ -21,12 +22,17 @@ export async function analyze(): Promise<void> {
     '--branch',
     BRANCH,
   ];
+  const getProjectArgs = (): string[] => !PROJECT ? [] : [
+    '--project',
+    PROJECT,
+  ];
 
   const getArgs = (cmd: string) => [
     CONTAINER ? 'container' : null,
     cmd,
     ...getEndpointArgs(),
     ...getBranchArgs(),
+    ...getProjectArgs(),
     DEBUG ? '--debug' : null,
   ].filter(arg => arg);