{"id":26493760,"url":"https://github.com/gacts/gitleaks","last_synced_at":"2025-03-20T09:57:11.504Z","repository":{"id":39707182,"uuid":"491279326","full_name":"gacts/gitleaks","owner":"gacts","description":"🚀 GitHub action for running gitleaks/gitleaks (no license key is required)","archived":false,"fork":false,"pushed_at":"2025-03-03T20:26:06.000Z","size":6173,"stargazers_count":15,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-09T21:40:34.662Z","etag":null,"topics":["code-scanning","github-actions","gitleaks","security"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/run-gitleaks","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gacts.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-11T21:37:29.000Z","updated_at":"2025-03-03T20:26:09.000Z","dependencies_parsed_at":"2024-03-01T17:31:27.815Z","dependency_job_id":"f5790857-d1ef-4a93-a19c-f4fba2c990ba","html_url":"https://github.com/gacts/gitleaks","commit_stats":{"total_commits":104,"total_committers":2,"mean_commits":52.0,"dds":"0.29807692307692313","last_synced_commit":"18524d2be9109cd08ea839baa85354bc3c786da3"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gacts%2Fgitleaks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gacts%2Fgitleaks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gacts%2Fgitleaks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gacts%2Fgitleaks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gacts","download_url":"https://codeload.github.com/gacts/gitleaks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244591484,"owners_count":20477709,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-scanning","github-actions","gitleaks","security"],"created_at":"2025-03-20T09:57:10.976Z","updated_at":"2025-03-20T09:57:11.499Z","avatar_url":"https://github.com/gacts.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/gacts/gitleaks/assets/7326800/778c1c79-c36b-4a52-83cd-3ab2a2bb8f3e\" alt=\"Logo\" width=\"250\" /\u003e\n\u003c/p\u003e\n\n# Run [GitLeaks][gitleaks] action\n\n![Release version][badge_release_version]\n[![Build Status][badge_build]][link_build]\n[![License][badge_license]][link_license]\n\nThis action provides a simple way to run [GitLeaks][gitleaks] in your CI/CD pipeline. It can be run on **Linux**\n(`ubuntu-latest`), **macOS** (`macos-latest`), or **Windows** (`windows-latest`).\n\nIn addition, it supports GitLeaks **v8.x** _(and v7.x)_, and uses the GitHub **caching mechanism** to speed up\nyour workflow execution time!\n\n\u003e [!TIP]\n\u003e The [config file](https://github.com/gitleaks/gitleaks/blob/master/config/gitleaks.toml) can be located\n\u003e in `.github` directory _(e.g.: `\u003crepo_root\u003e/.github/.gitleaks.toml`)_, and if `with.config-path` was not\n\u003e provided - it will be used.\n\n## Additional Configuration\n\n### `gitleaks:allow`\n\n\u003e [!NOTE]\n\u003e Since GitLeaks **v8.10.0**\n\nIf you are knowingly committing a test secret that GitLeaks will catch you can add a `gitleaks:allow` comment to\nthat line which will instruct GitLeaks to ignore that secret. Ex:\n\n```java\nclass CustomClass:\n    discord_client_secret = '8dyfuiRyq=vVc3RRr_edRk-fK__JItpZ' #gitleaks:allow\n```\n\n### `.gitleaksignore`\n\n\u003e [!NOTE]\n\u003e Since GitLeaks **v8.10.0**\n\nYou can ignore specific findings by creating a `.gitleaksignore` file at the root of your repo. In release v8.10.0\nGitLeaks added a `Fingerprint` value to the GitLeaks report. Each leak, or finding, has a Fingerprint that uniquely\nidentifies a secret. Add this fingerprint to the `.gitleaksignore` file to ignore that specific secret. See\nGitLeaks' [.gitleaksignore](https://github.com/gitleaks/gitleaks/blob/master/.gitleaksignore) for an example.\n\n\u003e [!NOTE]\n\u003e This feature is experimental and is subject to change in the future.\n\n## Usage\n\n```yaml\njobs:\n  gitleaks:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v3\n        with: {fetch-depth: 0}\n\n      - name: Check for GitLeaks\n        uses: gacts/gitleaks@v1\n        #id: gitleaks\n        #with:\n        #  version: latest\n        #  config-path: .github/.gitleaks.toml\n        #  path: any/directory/path\n\n      #- if: ${{ always() }} # reason - https://github.com/gitleaks/gitleaks/issues/782\n      #  uses: github/codeql-action/upload-sarif@v2\n      #  with:\n      #    sarif_file: ${{ steps.gitleaks.outputs.sarif }}\n```\n\n\u003e [!NOTE]\n\u003e You must use `actions/checkout` before the `gacts/gitleaks` step with `fetch-depth: 0`!\n\n## Customizing\n\n### Inputs\n\nFollowing inputs can be used as `step.with` keys:\n\n| Name            |   Type    |          Default          | Required | Description                                                              |\n|-----------------|:---------:|:-------------------------:|:--------:|--------------------------------------------------------------------------|\n| `version`       | `string`  |         `latest`          |   yes    | GitLeaks version (`latest` or in `1.2.3` format)                         |\n| `config-path`   | `string`  |         built-in          |    no    | Path to the config file                                                  |\n| `path`          | `string`  | current working directory |    no    | Path to source                                                           |\n| `run`           | `boolean` |          `true`           |    no    | Set it to `true` to run GitLeaks, or `false` if you don't want it to run |\n| `fail-on-error` | `boolean` |          `true`           |    no    | Set `false` for exiting without an error when GitLeaks run failed        |\n| `github-token`  | `string`  |   `${{ github.token }}`   |    no    | GitHub auth token                                                        |\n\n### Outputs\n\nIn subsequent steps you will be able to use the following variables:\n\n| Description                                                     | How to use in your workflow                  | Example                        |\n|-----------------------------------------------------------------|----------------------------------------------|--------------------------------|\n| Path to the GitLeaks binary file                                | `${{ steps.gitleaks.outputs.gitleaks-bin }}` | `/tmp/gitleaks-8.7.1/gitleaks` |\n| Path to the report in [SARIF format][sarif]                     | `${{ steps.gitleaks.outputs.sarif }}`        | `/tmp/gitleaks.sarif`          |\n| GitLeaks exit code (will be set only if `inputs.run` is `true`) | `${{ steps.gitleaks.outputs.exit-code }}`    | `1`                            |\n\n## How do I remove a secret from git's history?\n\n[GitHub][removing-sensitive-data] has a great article on this using the [BFG Repo Cleaner][bfg].\n\n[removing-sensitive-data]:https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository\n[bfg]:https://rtyley.github.io/bfg-repo-cleaner/\n\n## Alternative projects\n\n- [Official GitHub action](https://github.com/gitleaks/gitleaks-action) (license key is required)\n\n## Releasing\n\nTo release a new version:\n\n- Build the action distribution (`make build` or `npm run build`).\n- Commit and push changes (including `dist` directory changes - this is important) to the `master|main` branch.\n- Publish the new release using the repo releases page (the git tag should follow the `vX.Y.Z` format).\n\nMajor and minor git tags (`v1` and `v1.2` if you publish a `v1.2.Z` release) will be updated automatically.\n\n\u003e [!TIP]\n\u003e Use [Dependabot](https://bit.ly/45zwLL1) to keep this action updated in your repository.\n\n## Support\n\n[![Issues][badge_issues]][link_issues]\n[![Pull Requests][badge_pulls]][link_pulls]\n\nIf you find any errors in the action, please [create an issue][link_create_issue] in this repository.\n\n## License\n\nThis is open-source software licensed under the [MIT License][link_license].\n\n[badge_build]:https://img.shields.io/github/actions/workflow/status/gacts/gitleaks/tests.yml?branch=master\u0026maxAge=30\n[badge_release_version]:https://img.shields.io/github/release/gacts/gitleaks.svg?maxAge=30\n[badge_license]:https://img.shields.io/github/license/gacts/gitleaks.svg?longCache=true\n[badge_release_date]:https://img.shields.io/github/release-date/gacts/gitleaks.svg?maxAge=180\n[badge_commits_since_release]:https://img.shields.io/github/commits-since/gacts/gitleaks/latest.svg?maxAge=45\n[badge_issues]:https://img.shields.io/github/issues/gacts/gitleaks.svg?maxAge=45\n[badge_pulls]:https://img.shields.io/github/issues-pr/gacts/gitleaks.svg?maxAge=45\n\n[link_build]:https://github.com/gacts/gitleaks/actions\n[link_license]:https://github.com/gacts/gitleaks/blob/master/LICENSE\n[link_issues]:https://github.com/gacts/gitleaks/issues\n[link_create_issue]:https://github.com/gacts/gitleaks/issues/new\n[link_pulls]:https://github.com/gacts/gitleaks/pulls\n\n[gitleaks]:https://github.com/gitleaks/gitleaks\n[sarif]:https://github.com/microsoft/sarif-tutorials\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgacts%2Fgitleaks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgacts%2Fgitleaks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgacts%2Fgitleaks/lists"}