Skip to content

Commit 90697e3

Browse files
authored
feat: add repository_dispatch event (#92)
1 parent 5dd9829 commit 90697e3

File tree

5 files changed

+62
-6
lines changed

5 files changed

+62
-6
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -537,6 +537,7 @@ If there are actions for a webhook, events are emitted for both, the webhook nam
537537
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#pushevent"><code>push</code></a></td><td class="actions-td td_num"></td></tr>
538538
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#registrypackageevent"><code>registry_package</code></a></td><td class="actions-td td_text"><code>published</code><br><code>updated</code></td></tr>
539539
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#releaseevent"><code>release</code></a></td><td class="actions-td td_text"><code>created</code><br><code>deleted</code><br><code>edited</code><br><code>prereleased</code><br><code>published</code><br><code>unpublished</code></td></tr>
540+
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#repositorydispatchevent"><code>repository_dispatch</code></a></td><td class="actions-td td_num"></td></tr>
540541
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#repositoryevent"><code>repository</code></a></td><td class="actions-td td_text"><code>archived</code><br><code>created</code><br><code>deleted</code><br><code>edited</code><br><code>privatized</code><br><code>publicized</code><br><code>renamed</code><br><code>transferred</code><br><code>unarchived</code></td></tr>
541542
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#repositoryimportevent"><code>repository_import</code></a></td><td class="actions-td td_num"></td></tr>
542543
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#repositoryvulnerabilityalertevent"><code>repository_vulnerability_alert</code></a></td><td class="actions-td td_text"><code>create</code><br><code>dismiss</code><br><code>resolve</code></td></tr>

index.d.ts

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,53 @@ declare namespace Webhooks {
434434
repository: PayloadRepository;
435435
sender: WebhookPayloadRepositorySender;
436436
};
437+
type WebhookPayloadRepositoryDispatchInstallation = {
438+
id: number;
439+
node_id: string;
440+
};
441+
type WebhookPayloadRepositoryDispatchSender = {
442+
login: string;
443+
id: number;
444+
node_id: string;
445+
avatar_url: string;
446+
gravatar_id: string;
447+
url: string;
448+
html_url: string;
449+
followers_url: string;
450+
following_url: string;
451+
gists_url: string;
452+
starred_url: string;
453+
subscriptions_url: string;
454+
organizations_url: string;
455+
repos_url: string;
456+
events_url: string;
457+
received_events_url: string;
458+
type: string;
459+
site_admin: boolean;
460+
};
461+
type WebhookPayloadRepositoryDispatchOrganization = {
462+
login: string;
463+
id: number;
464+
node_id: string;
465+
url: string;
466+
repos_url: string;
467+
events_url: string;
468+
hooks_url: string;
469+
issues_url: string;
470+
members_url: string;
471+
public_members_url: string;
472+
avatar_url: string;
473+
description: string;
474+
};
475+
type WebhookPayloadRepositoryDispatch = {
476+
action: string;
477+
branch: string;
478+
ref: string;
479+
repository: PayloadRepository;
480+
organization: WebhookPayloadRepositoryDispatchOrganization;
481+
sender: WebhookPayloadRepositoryDispatchSender;
482+
installation: WebhookPayloadRepositoryDispatchInstallation;
483+
};
437484
type WebhookPayloadReleaseSender = {
438485
login: string;
439486
id: number;
@@ -3761,7 +3808,7 @@ declare namespace Webhooks {
37613808
private: boolean;
37623809
owner: PayloadRepositoryOwner;
37633810
html_url: string;
3764-
description: null;
3811+
description: null | string;
37653812
fork: boolean;
37663813
url: string;
37673814
forks_url: string;
@@ -3807,7 +3854,7 @@ declare namespace Webhooks {
38073854
ssh_url: string;
38083855
clone_url: string;
38093856
svn_url: string;
3810-
homepage: null;
3857+
homepage: null | string;
38113858
size: number;
38123859
stargazers_count: number;
38133860
watchers_count: number;
@@ -4417,6 +4464,13 @@ declare class Webhooks {
44174464
) => Promise<void> | void
44184465
): void;
44194466

4467+
public on(
4468+
event: "repository_dispatch",
4469+
callback: (
4470+
event: Webhooks.WebhookEvent<Webhooks.WebhookPayloadRepositoryDispatch>
4471+
) => Promise<void> | void
4472+
): void;
4473+
44204474
public on(
44214475
event:
44224476
| "repository"

lib/webhook-names.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@
149149
"repository.renamed",
150150
"repository.transferred",
151151
"repository.unarchived",
152+
"repository_dispatch",
152153
"repository_import",
153154
"repository_vulnerability_alert",
154155
"repository_vulnerability_alert.create",

package-lock.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
},
1616
"devDependencies": {
1717
"@gimenete/type-writer": "^0.1.3",
18-
"@octokit/webhooks-definitions": "1.4.2",
18+
"@octokit/webhooks-definitions": "1.5.1",
1919
"axios": "^0.19.0",
2020
"cheerio": "^1.0.0-rc.2",
2121
"coveralls": "^3.0.3",

0 commit comments

Comments
 (0)