Skip to content

Commit 7494de9

Browse files
committed
Document in readme
1 parent f0539db commit 7494de9

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,27 @@ jobs:
197197
```
198198

199199

200+
### `pinned-cli-version`
201+
202+
**Optional** By default, the action will use the latest version of FOSSA CLI.
203+
In some specific circumstances it makes sense to pin the version of the CLI used by the action.
204+
To do that you can use `pinned-cli-version`:
205+
206+
```yml
207+
jobs:
208+
fossa-scan:
209+
runs-on: ubuntu-latest
210+
- uses: actions/checkout@v3
211+
- uses: fossas/fossa-action@main
212+
with:
213+
api-key: ${{secrets.FOSSA_API_KEY}}
214+
pinned-cli-version: v3.0.0
215+
- uses: actions/upload-artifact@v3
216+
with:
217+
name: fossa.debug.json.gz
218+
path: ./fossa.debug.json.gz
219+
```
220+
200221
### `working-directory`
201222

202223
**Optional** By default, the action will scan anything in the default github actions working directory. Use this option to scan a project in a different directory.
@@ -207,7 +228,7 @@ jobs:
207228
runs-on: ubuntu-latest
208229
steps:
209230
- uses: actions/checkout@v4
210-
with:
231+
with:
211232
path: my-working-directory
212233
- uses: fossas/fossa-action@main
213234
with:

0 commit comments

Comments
 (0)