fix(secret): fix the example of commit range given in commit-range cmd #1028
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1028 +/- ##
=======================================
Coverage 92.03% 92.03%
=======================================
Files 181 181
Lines 7708 7708
=======================================
Hits 7094 7094
Misses 614 614
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
sevbch
approved these changes
Dec 4, 2024
agateau-gg
reviewed
Dec 4, 2024
| @@ -32,7 +32,7 @@ def range_cmd( | |||
|
|
|||
| Any git compatible commit range can be provided as an input. | |||
|
|
|||
| Example: `ggshield secret scan commit-range HEAD~1...` | |||
There was a problem hiding this comment.
This is a valid git range:
$ ggshield secret scan commit-range HEAD~1... -v
Commits to scan: 1
Scanned changelog.d/20241129_155452_samuel.guillaume_spi_526_implement_deletion_commit_identification_in_ggshield.md
Scanned ggshield/verticals/secret/secret_scan_collection.py
Scanned ggshield/verticals/secret/secret_scanner.py
Scanned b34d26479d3fd44fb07d53ddd11ae9bf8957524c
Scanning... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 1 / 1
secrets-engine-version: 2.127.0
No secrets have been found
See git-rev-list doc for more details.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Context
One of our user rightfully reported that the example of commit range given in the
secret scan commit-rangecommand was invalid.This PR corrects it
What has been done
Just corrected the example. It will also automatically update our documentation https://docs.gitguardian.com/ggshield-docs/reference/secret/scan/commit-range
PR check list
skip-changeloglabel has been added to the PR.