-
Notifications
You must be signed in to change notification settings - Fork 138
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
Add support for custom remediation messages #928
base: main
Are you sure you want to change the base?
Add support for custom remediation messages #928
Conversation
b5b3250
to
bc98683
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #928 +/- ##
==========================================
+ Coverage 91.18% 91.36% +0.17%
==========================================
Files 176 176
Lines 7252 7241 -11
==========================================
+ Hits 6613 6616 +3
+ Misses 639 625 -14
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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.
Minor remarks, looks fine otherwise 👍
...40701_180409_fnareoh_scrt_4626_ggshield_display_custom_remediation_message_in_ggshield_if.md
Outdated
Show resolved
Hide resolved
459eee6
to
c12e2ad
Compare
Context
This MR adds the display of custom remediation messages defined in the gitguardian plateform.
What has been done
This MR relies on the changes on pygitguardian GitGuardian/py-gitguardian#111
And for a custom remediation message to be display in ggshield the instance has to expose the messages through the metadata endpoint (see internal MR).
Validation
This version of ggshield should be compatible with versions of the app that do not yet expose the remediation messages (current staging for example) with the metadata endpoint and a version that does (review app of the MR that exposes to the public api).
Set the right instance for example using the env variable
GITGUARDIAN_INSTANCE
andGITGUARDIAN_API_KEY
the try theggshield secret scan pre-commit
after leaking a secret andggshield secret scan pre-push
after commiting a secret but I am not sure how to test the pre-receive :(PR check list
skip-changelog
label has been added to the PR.