Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dhsathiya/gitleaks-action
Maintained version of Gitleaks GitHub Action
https://github.com/dhsathiya/gitleaks-action
Last synced: 5 days ago
JSON representation
Maintained version of Gitleaks GitHub Action
- Host: GitHub
- URL: https://github.com/dhsathiya/gitleaks-action
- Owner: dhsathiya
- License: mit
- Created: 2022-06-28T20:36:05.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-28T21:41:05.000Z (over 2 years ago)
- Last Synced: 2024-03-15T11:04:19.357Z (8 months ago)
- Language: Shell
- Homepage:
- Size: 14.6 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gitleaks GitHub Action
Gitleaks Action provides a simple way to run Gitleaks in your CI/CD pipeline.
## Why here?
This repository is here to support the Gitleaks action with all the updates from [Gitleaks source project](https://github.com/zricethezav/gitleaks). With the new 2.0 version of [gitleaks/gitleaks-action GitHub Action](https://github.com/gitleaks/gitleaks-action#-why-is-my-gitleaks-action-job-suddenly-failing) they went to a commercial licence.
### Sample Workflow
```
name: gitleaks
on: [push,pull_request]
jobs:
gitleaks:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: gitleaks-action
uses: dhsathiya/gitleaks-action@master
```
### Using your own .gitleaks.toml configuration
```
name: gitleaks
on: [push,pull_request]
jobs:
gitleaks:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: gitleaks-action
uses: dhsathiya/gitleaks-action@master
with:
config-path: security/.gitleaks.toml
```
> The `config-path` is relative to your GitHub Worskpace
### NOTE!!!
You must use `actions/checkout` before the gitleaks-action step. If you are using `actions/checkout@v2` you must specify a commit depth other than the default which is 1.
ex:
```
steps:
- uses: actions/checkout@v2
with:
fetch-depth: '0'
- name: gitleaks-action
uses: dhsathiya/gitleaks-action@master
```
using a fetch-depth of '0' clones the entire history. If you want to do a more efficient clone, use '2', but that is not guaranteed to work with pull requests.
## Credits
Gitleaks Project: https://github.com/zricethezav/gitleaks
Source: https://github.com/gitleaks/gitleaks-action