fix: change sender field for CodeScanningAlert event to match other payloads#3855
fix: change sender field for CodeScanningAlert event to match other payloads#3855shati-patel merged 3 commits intogithub:mainfrom
Conversation
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
There was a problem hiding this comment.
👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are:
translations/**
lib/rest/static/**
.github/workflows/**
.github/CODEOWNERS
translations/**
assets/fonts/**
data/graphql/**
lib/graphql/**
lib/redirects/**
lib/rest/**
lib/webhooks/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. ![]()
|
Hi @wolfy1339, thank you for the pull request 😃 I've checked with our code scanning team and your updated example looks good. If you'd like to reopen this pull request, we'd love to take the contribution! Otherwise, we can make the change internally. Thanks again for helping us improve our docs 🎉 |
|
I reopened the pull request |
|
Fixes #3906 |
shati-patel
left a comment
There was a problem hiding this comment.
Thank you! I'll get this merged shortly.
Overridden manually
There was a problem hiding this comment.
👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are:
translations/**
lib/rest/static/**
.github/workflows/**
.github/CODEOWNERS
translations/**
assets/fonts/**
data/graphql/**
lib/graphql/**
lib/redirects/**
lib/rest/**
lib/webhooks/**
You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. ![]()
overridden manually
Why:
In octokit/webhooks#371, a GitHub staffer sent us a PR with some new payload examples for the CodeScanningAlert event, the sender field was set to the value of the Github user (roughly the values of the REST endpoint
GET /users/github) and not the GitHub org (the values of the REST endpointGET /orgs/github)All the other webhooks use the values that resemble the
GET /users/{user}enpoint.What's being changed:
Updates the
senderfield for theCodeScanningAlertevent to reflect my findings, and to match the other webhook payloadsCheck off the following: