Skip to content

Commit

Permalink
feat: webhooks updates (#619)
Browse files Browse the repository at this point in the history
* fix: add `waiting` state to `deployment_status`, `check_run` and `workflow_run` event
Ref: octokit/webhooks.net#52

* fix: add `skipped` to `workflow_run` conclusion
Ref: octokit/webhooks.net#57

* fix: update the `pull_request` property description on `check_run` event
* feat: add `pull_request_review_thread` examples,
The event was recently added to the docs

* feat(GHES): new event: `package`
* feat(GHES): new `pull_request_review_thread` event
* fix(GHES): event description updates
* feat(GHAE): new `pull_request_review_thread` event
* fix(GHAE): description updates
* feat: remove `secret_scanning_alert` from `index.json`

Co-authored-by: Octokit Bot <octokitbot@martynus.net>
Co-authored-by: wolfy1339 <webmaster@wolfy1339.com>
  • Loading branch information
3 people committed Apr 28, 2022
1 parent 85071d6 commit 1c4b64c
Show file tree
Hide file tree
Showing 21 changed files with 12,200 additions and 5,546 deletions.
2,469 changes: 1,499 additions & 970 deletions cache/api.github.com/webhook-events-and-payloads.html

Large diffs are not rendered by default.

103 changes: 93 additions & 10 deletions cache/ghes-221/webhook-events-and-payloads.html
Expand Up @@ -5,7 +5,11 @@ <h1 class="my-4 border-bottom-0">Webhook events and payloads</h1>
<span
role="tooltip"
aria-label="Print this article"
class="Tooltip__TooltipBase-kp39nc-0 jIaMtK tooltipped-n tooltipped-no-delay"
class="
Tooltip__TooltipBase-kp39nc-0
jIaMtK
tooltipped-n tooltipped-no-delay
"
><button class="btn-link Link--muted">
<svg
xmlns="http://www.w3.org/2000/svg"
Expand Down Expand Up @@ -33,7 +37,14 @@ <h1 class="my-4 border-bottom-0">Webhook events and payloads</h1>
</div>
</div>
<div
class="ArticleGridLayout_sidebar__1eMns border-bottom border-xl-0 pb-4 mb-5 pb-xl-0 mb-xl-0"
class="
ArticleGridLayout_sidebar__1eMns
border-bottom border-xl-0
pb-4
mb-5
pb-xl-0
mb-xl-0
"
>
<div class="ArticleGridLayout_sidebarContent__3bZPH">
<h2 id="in-this-article" class="f5 mb-2">
Expand Down Expand Up @@ -237,7 +248,16 @@ <h2 id="webhook-payload-object-common-properties">
payload contains more detailed information.
</p>
<div
class="extended-markdown tip border rounded-1 mb-4 p-3 color-border-info color-bg-info f5"
class="
extended-markdown
tip
border
rounded-1
mb-4
p-3
color-border-info color-bg-info
f5
"
>
<p>
<strong>Note:</strong> Payloads are capped at 25 MB. If your event
Expand Down Expand Up @@ -356,7 +376,16 @@ <h2 id="check_run"><a href="#check_run">check_run</a></h2>
>" REST API.
</p>
<div
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-info color-bg-info f5"
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-info color-bg-info
f5
"
>
<p>
<strong>Note:</strong> The Checks API only looks for pushes in the
Expand Down Expand Up @@ -944,7 +973,16 @@ <h2 id="check_suite"><a href="#check_suite">check_suite</a></h2>
>" REST API.
</p>
<div
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-info color-bg-info f5"
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-info color-bg-info
f5
"
>
<p>
<strong>Note:</strong> The Checks API only looks for pushes in the
Expand Down Expand Up @@ -1568,7 +1606,16 @@ <h2 id="create"><a href="#create">create</a></h2>
>" REST API.
</p>
<div
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-info color-bg-info f5"
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-info color-bg-info
f5
"
>
<p>
<strong>Note:</strong> You will not receive a webhook for this event
Expand Down Expand Up @@ -1827,7 +1874,16 @@ <h2 id="delete"><a href="#delete">delete</a></h2>
>" REST API.
</p>
<div
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-info color-bg-info f5"
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-info color-bg-info
f5
"
>
<p>
<strong>Note:</strong> You will not receive a webhook for this event
Expand Down Expand Up @@ -3560,7 +3616,16 @@ <h2 id="installation"><a href="#installation">installation</a></h2>
>" REST API.
</p>
<div
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-info color-bg-info f5"
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-info color-bg-info
f5
"
>
<p>
<strong>Note:</strong> This event replaces the deprecated
Expand Down Expand Up @@ -3762,7 +3827,16 @@ <h2 id="installation_repositories">
>" REST API.
</p>
<div
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-info color-bg-info f5"
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-info color-bg-info
f5
"
>
<p>
<strong>Note:</strong> This event replaces the deprecated
Expand Down Expand Up @@ -9542,7 +9616,16 @@ <h3 id="webhook-payload-example-29">
<h2 id="push"><a href="#push">push</a></h2>
<p>One or more commits are pushed to a repository branch or tag.</p>
<div
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-info color-bg-info f5"
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-info color-bg-info
f5
"
>
<p>
<strong>Note:</strong> You will not receive a webhook for this event
Expand Down
86 changes: 78 additions & 8 deletions cache/ghes-222/webhook-events-and-payloads.html
Expand Up @@ -42,7 +42,13 @@
>
<div>
<details
class="Details-ssy9qz-0 lbxfz position-relative details-reset d-inline-block"
class="
Details-ssy9qz-0
lbxfz
position-relative
details-reset
d-inline-block
"
data-testid="article-version-picker"
>
<summary aria-haspopup="true" class="btn btn-sm">
Expand Down Expand Up @@ -135,7 +141,17 @@
</div>
</div>
<div
class="Box-nv15kw-0 ArticleGridLayout__SidebarContent-sc-we7dhr-1 kpUcPL sEXfN border-bottom border-xl-0 pb-4 mb-5 pb-xl-0 mb-xl-0"
class="
Box-nv15kw-0
ArticleGridLayout__SidebarContent-sc-we7dhr-1
kpUcPL
sEXfN
border-bottom border-xl-0
pb-4
mb-5
pb-xl-0
mb-xl-0
"
>
<h2 font-size="1" id="in-this-article" class="Heading-sc-1cjoo9h-0 wHdB mb-1">
<a class="Link--primary" href="#in-this-article">In this article</a>
Expand Down Expand Up @@ -464,7 +480,16 @@ <h2 id="webhook-payload-object-common-properties">
payload contains more detailed information.
</p>
<div
class="extended-markdown tip border rounded-1 mb-4 p-3 color-border-info color-bg-info f5"
class="
extended-markdown
tip
border
rounded-1
mb-4
p-3
color-border-info color-bg-info
f5
"
>
<p>
<strong>Note:</strong> Payloads are capped at 25 MB. If your event
Expand Down Expand Up @@ -651,7 +676,16 @@ <h2 id="check_run">
>" REST API.
</p>
<div
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-info color-bg-info f5"
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-info color-bg-info
f5
"
>
<p>
<strong>Note:</strong> The Checks API only looks for pushes in the
Expand Down Expand Up @@ -1341,7 +1375,16 @@ <h2 id="check_suite">
>" REST API.
</p>
<div
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-info color-bg-info f5"
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-info color-bg-info
f5
"
>
<p>
<strong>Note:</strong> The Checks API only looks for pushes in the
Expand Down Expand Up @@ -2841,7 +2884,16 @@ <h2 id="create">
>" REST API.
</p>
<div
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-info color-bg-info f5"
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-info color-bg-info
f5
"
>
<p>
<strong>Note:</strong> You will not receive a webhook for this event
Expand Down Expand Up @@ -3193,7 +3245,16 @@ <h2 id="delete">
>" REST API.
</p>
<div
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-info color-bg-info f5"
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-info color-bg-info
f5
"
>
<p>
<strong>Note:</strong> You will not receive a webhook for this event
Expand Down Expand Up @@ -13447,7 +13508,16 @@ <h2 id="push">
</h2>
<p>One or more commits are pushed to a repository branch or tag.</p>
<div
class="extended-markdown note border rounded-1 mb-4 p-3 color-border-info color-bg-info f5"
class="
extended-markdown
note
border
rounded-1
mb-4
p-3
color-border-info color-bg-info
f5
"
>
<p>
<strong>Note:</strong> You will not receive a webhook for this event
Expand Down

0 comments on commit 1c4b64c

Please sign in to comment.