Skip to content

Commit a7039b3

Browse files
committed
0.1.4 release
1 parent 63f3f76 commit a7039b3

2 files changed

Lines changed: 9 additions & 17 deletions

File tree

README.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
This action utilizes [Salus](https://github.com/coinbase/salus) from Coinbase to run SAST and dependency scans.
44

5-
Bundle Audit, Brakeman, NPM Audit, and Yarn Audit reports can optionally be sent to [SecureDevelopment by Federacy](https://www.securedevelopment.com) for analysis.
6-
75
## Scanners supported
86

97
| Name | Language |
@@ -20,6 +18,8 @@ Bundle Audit, Brakeman, NPM Audit, and Yarn Audit reports can optionally be sent
2018

2119
## Example usage
2220

21+
`.github/workflows/example.yml`
22+
2323
### Defaults
2424

2525
```
@@ -33,7 +33,7 @@ jobs:
3333
- uses: actions/checkout@v1
3434
- name: Salus Scan
3535
id: salus_scan
36-
uses: federacy/scan-action@0.1.1
36+
uses: federacy/scan-action@0.1.4
3737
```
3838

3939
### Single scanner
@@ -49,7 +49,7 @@ jobs:
4949
- uses: actions/checkout@v1
5050
- name: Salus Scan
5151
id: salus_scan
52-
uses: federacy/scan-action@0.1.1
52+
uses: federacy/scan-action@0.1.4
5353
with:
5454
active_scanners: "\n - Brakeman"
5555
enforced_scanners: "\n - Brakeman"
@@ -68,7 +68,7 @@ jobs:
6868
- uses: actions/checkout@v1
6969
- name: Salus Scan
7070
id: salus_scan
71-
uses: federacy/scan-action@0.1.1
71+
uses: federacy/scan-action@0.1.4
7272
with:
7373
enforced_scanners: "none"
7474
```
@@ -86,7 +86,7 @@ jobs:
8686
- uses: actions/checkout@v1
8787
- name: Salus Scan
8888
id: salus_scan
89-
uses: federacy/scan-action@0.1.1
89+
uses: federacy/scan-action@0.1.4
9090
env:
9191
SALUS_CONFIGURATION: "file://../salus-configuration.yaml file://config/pattern_search.yaml"
9292
```
@@ -97,7 +97,7 @@ jobs:
9797
| --------- | ----------- | ------- | ------- |
9898
| active_scanners | Scanners to run | all | Brakeman, PatternSearch, BundleAudit, NPMAudit, GoSec |
9999
| enforced_scanners | Scanners that block builds | all | Brakeman, PatternSearch, BundleAudit, NPMAudit, GoSec |
100-
| report_uri | Where to send Salus reports | file://../salus-report.json | Any URI |
100+
| report_uri | Where to send Salus reports | file://salus-report.json | Any URI |
101101
| report_format | What format to use for report | json | json, yaml, txt |
102102
| report_verbosity | Whether to enable a verbose report | true | true, false |
103103
| salus_configuration | Where to find Salus configuration | file://../salus-configuration.yaml | Any URI |
@@ -127,15 +127,7 @@ Stored in custom_info of a Salus scan.
127127
| github_base_ref | GITHUB_BASE_REF | Ref of the base repository, if forked |
128128
| github_home | HOME | Path to home directory used by Github |
129129

130-
## Sending reports to dashboard
131-
132-
Steps:
133-
134-
1. Create free account on [SecureDevelopment by Federacy](https://www.securedevelopment.com)
135-
2. Click 'Applications' in navbar
136-
3. Click 'Create Application'
137-
4. Copy example job to your workflow in `.github/workflows`
138-
139130
## Contributors
140131

141132
[Chris Czub](https://github.com/zbuc)
133+
[Andre Azzolini](https://github.com/apazzolini)

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ inputs:
1717
report_uri:
1818
description: 'Where to send Salus reports'
1919
required: false
20-
default: 'file://../salus-report.json'
20+
default: 'file://salus-report.json'
2121
report_format:
2222
description: 'Format of the report (json, yaml, txt)'
2323
required: false

0 commit comments

Comments
 (0)