Commit 462ced51 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

Merge branch '24-add-report-table-for-the-generated-artifact' into 'master' 

Resolve "Add report table for the generated artifact"

Closes #24

See merge request to-be-continuous/gitleaks!65
parents c259fc7b 9e9586e4

README.md

+6 −0
Original line number Diff line number Diff line
@@ -52,6 +52,12 @@ They use the following configuration. 
| `rules` / `GITLEAKS_RULES` | Gitleaks [configuration rules](https://github.com/zricethezav/gitleaks#configuration) to use (you may also provide your own `.gitleaks.toml` configuration file in your project). | _none_ (uses default rules) |

| `args` / `GITLEAKS_ARGS` | [Options](https://github.com/zricethezav/gitleaks/wiki/Options) for a full Gitleaks analysis (on master or develop branches) | `--verbose --redact` |



In addition to a textual report in the console, this job produces the following reports, kept for one day and only available for download by users with the Developer role or higher:



| Report         | Format                                                                       | Usage             |

| -------------- | ---------------------------------------------------------------------------- | ----------------- |

| `reports/gitleaks.native.json` | [JSON](https://github.com/gitleaks/gitleaks?tab=readme-ov-file#reporting) | [DefectDojo integration](https://docs.defectdojo.com/supported_tools/parsers/file/gitleaks/) |



### Configuring Gitleaks rules



Here is how this GitLab CI template chooses the Gitleaks rules to use: