Skip to content

fix: change sender field for CodeScanningAlert event to match other payloads #3855

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 3 commits into from
Feb 25, 2021

Conversation

wolfy1339
Copy link
Contributor

@wolfy1339 wolfy1339 commented Feb 21, 2021

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 endpoint GET /orgs/github)

All the other webhooks use the values that resemble the GET /users/{user} enpoint.

What's being changed:

Updates the sender field for the CodeScanningAlert event to reflect my findings, and to match the other webhook payloads

Check off the following:

@welcome
Copy link

welcome bot commented Feb 21, 2021

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.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 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. :octocat:

@wolfy1339 wolfy1339 closed this Feb 24, 2021
@wolfy1339 wolfy1339 deleted the patch-1 branch February 24, 2021 00:15
@shati-patel
Copy link
Contributor

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 🎉

@wolfy1339
Copy link
Contributor Author

I reopened the pull request

@wolfy1339
Copy link
Contributor Author

Fixes #3906

@shati-patel shati-patel linked an issue Feb 25, 2021 that may be closed by this pull request
Copy link
Contributor

@shati-patel shati-patel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I'll get this merged shortly.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 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. :octocat:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify the sender property of the CodeScanningEvent webhook
2 participants