Skip to content

Commit 755c824

Browse files
authored
Update README.md
1 parent 433dfb4 commit 755c824

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,49 @@
11
# coverity-on-polaris-workflow
22
A Github action workflow for Coverity on Polaris
3+
4+
## Input
5+
6+
```yaml
7+
inputs:
8+
api_url:
9+
description: |
10+
Coverity on Polaris API URL
11+
Usually something along the lines of https://{instance_name}.polaris.synopsys.com
12+
required: true
13+
access_token:
14+
description: 'Polaris access token'
15+
required: true
16+
```
17+
18+
## Usage
19+
20+
```yaml
21+
name: SAST
22+
on:
23+
workflow_dispatch:
24+
workflow_call:
25+
schedule:
26+
- cron: "0 12 * * *" # Runs at 12:00 everyday
27+
28+
env:
29+
DOTNET_NOLOGO: 1
30+
DOTNET_CLI_TELEMETRY_OPTOUT: 1
31+
32+
jobs:
33+
analyze:
34+
name: Capture and send
35+
runs-on: ubuntu-latest
36+
steps:
37+
- name: Checkout repo
38+
uses: actions/checkout@v3
39+
40+
- name: Install dependencies
41+
run: |
42+
dotnet restore
43+
44+
- name: Static application security testing
45+
uses: visma-prodsec/coverity-on-polaris-workflow@v1
46+
with:
47+
api_url: ${{ vars.COVERITY_ON_POLARIS_API_URL }}
48+
access_token: ${{ secrets.VISMAINDEX_POLARIS_ACCESS_TOKEN }}
49+
```

0 commit comments

Comments
 (0)