Update Codescanning Webhook Docs to Include Default Sender Field #3565
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.
Why:
We're adding GitHub as the default sender field in the code-scanning alert payload.
What's being changed:
Hi there 👋
I'm from the codescanning Team at GitHub and we're doing a slight update. Previously:
See here for more info: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#code_scanning_alert
Now, we'll include a default sender object instead of having that field be empty and want the docs to reflect the default field value.
Related Links:
payload example PR: octokit/webhooks#366 (comment)
cc/ @bogdanap @anaarmas @krukow
Check off the following: