Skip to content

Commit 4af3690

Browse files
authored
Merge pull request #21 from soulshake/for-dummies
Add link to downloads in README.md
2 parents 7f4253b + 1de4bfb commit 4af3690

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A standalone tool that converts gosec results to Codacy's format. It allows the
1111

1212
2. Converts gosec result into Codacy's format
1313

14-
3. Prints Codacy's format to stdout
14+
3. Prints Codacy's format to stdout
1515

1616
> NOTE: the tool must be run in the project root folder.
1717
@@ -24,14 +24,15 @@ To get your gosec results into Codacy you'll need to:
2424
- Enable the setting “Run analysis through build server” under your repository Settings > General > Repository analysis
2525
- Obtain a [project API token](https://docs.codacy.com/codacy-api/api-tokens/#project-api-tokens)
2626
- Install [gosec](https://github.com/securego/gosec#install)
27+
- Download the `codacy-gosec` binary (or Java jar) from [the releases page](https://github.com/codacy/codacy-gosec/releases)
2728

2829

2930
### Sending the results to Codacy
3031

3132
Sending the results of running gosec to Codacy involves the steps below, which you can automate in your CI build process:
3233

3334
1. Run gosec
34-
2. Convert the gosec output to a format that the Codacy API accepts
35+
2. Convert the gosec output to a format that the Codacy API accepts using the [codacy-gosec](https://github.com/codacy/codacy-gosec/releases) binary
3536
3. Send the results to Codacy
3637
4. Finally, signal that Codacy can use the sent results and start a new analysis
3738

0 commit comments

Comments
 (0)