-
Notifications
You must be signed in to change notification settings - Fork 5
Add Guidance on Gitleaks GitHub Action License Requirements #118
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| title: Gitleaks Action License | ||
| description: Navigate gitleaks license requirements for the GitHub action. | ||
| permalink: /resources/gitleaks-action-license/ | ||
| layout: layouts/page | ||
| section: resources | ||
| tags: ospo | ||
| eleventyNavigation: | ||
| parent: ospo-resources | ||
| key: ospo-resources-gitleaksactionlicense | ||
| order: 10 | ||
| title: Gitleaks Action License | ||
| sidenav: true | ||
| sticky_sidenav: true | ||
| --- | ||
|
|
||
| # **Gitleaks GitHub Action License Requirements Explained** | ||
|
|
||
| This document addresses the difference in licensing requirements between **gitleaks/gitleaks-action** (version 2 and later) and **gacts/gitleaks**, specifically regarding the need for a license key when scanning repositories belonging to an organization. | ||
|
|
||
| # **Gitleaks Action v2 and Organization Licensing** | ||
|
|
||
| The official GitHub Action, **gitleaks/gitleaks-action** (v2 and newer), now requires a license key when used to scan repositories that belong to a GitHub organization. | ||
|
|
||
| Please note that if you are scanning repos that belong to an organization, you'll have to [acquire a `GITLEAKS_LICENSE`](http://gitleaks.io) to use v2 (free "Trial" license available). | ||
|
|
||
| This licensing change may be surprising to users who previously used Gitleaks-Action free of charge. The reasoning and context for this decision to monetize the project are fully detailed in an official blog post: \<[https://blog.gitleaks.io/gitleaks-llc-announcement-d7d06a52e801](https://blog.gitleaks.io/gitleaks-llc-announcement-d7d06a52e801)\> | ||
|
|
||
| The license key is passed to the action using the `GITLEAKS_LICENSE` environment variable. | ||
|
|
||
| # **Comparison with *gacts/gitleaks*** | ||
|
|
||
| In contrast, the community-maintained GitHub Action, **gacts/gitleaks**, does not require a license key for use with organizations. | ||
|
|
||
| **gacts/gitleaks** typically wraps the Gitleaks binary itself but operates independently of the licensing structure introduced in the official **gitleaks/gitleaks-action** for organizational use. Users who prefer a zero-cost option for organization-wide scanning can often utilize community forks or alternative actions like **gacts/gitleaks**. | ||
|
|
||
| The difference in licensing reflects a divergence in the support and maintenance models for these two actions |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tagging @DSACMS/eng-handbook-approvers to review this new addition to the DSAC Engineering Handbook!