File tree Expand file tree Collapse file tree 1 file changed +15
-4
lines changed Expand file tree Collapse file tree 1 file changed +15
-4
lines changed Original file line number Diff line number Diff line change @@ -17,12 +17,23 @@ A standalone tool that converts gosec results to Codacy's format. It allows the
17
17
18
18
## Usage
19
19
20
- The upload of results for a commit is done in two steps:
20
+ ### Requirements
21
21
22
- - uploading all results
23
- - telling Codacy that it can run the rest of the analysis
22
+ To get your gosec results into Codacy you'll need to:
24
23
25
- For this a [ project API] ( https://support.codacy.com/hc/en-us/articles/207994675-Project-API ) token is required.
24
+ - Enable the setting “Run analysis through build server” under your repository Settings > General > Repository analysis
25
+ - Obtain a [ Project API token] ( https://support.codacy.com/hc/en-us/articles/207994675-Project-API )
26
+ - Install [ gosec] ( https://github.com/securego/gosec#install )
27
+
28
+
29
+ ### Sending the results to Codacy
30
+
31
+ Sending the results of running gosec to Codacy involves the steps below, which you can automate in your CI build process:
32
+
33
+ 1 . Run gosec
34
+ 2 . Convert the gosec output to a format that the Codacy API accepts
35
+ 3 . Send the results to Codacy
36
+ 4 . Finally, signal that Codacy can use the sent results and start a new analysis
26
37
27
38
``` bash
28
39
export PROJECT_TOKEN=" YOUR-TOKEN"
You can’t perform that action at this time.
0 commit comments