Skip to content
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

🤖📯 Octokit webhooks changed #619

Merged
merged 22 commits into from
Apr 28, 2022
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
616 changes: 490 additions & 126 deletions cache/api.github.com/webhook-events-and-payloads.html

Large diffs are not rendered by default.

142 changes: 80 additions & 62 deletions cache/ghes-31/webhook-events-and-payloads.html

Large diffs are not rendered by default.

142 changes: 80 additions & 62 deletions cache/ghes-32/webhook-events-and-payloads.html

Large diffs are not rendered by default.

146 changes: 82 additions & 64 deletions cache/ghes-33/webhook-events-and-payloads.html

Large diffs are not rendered by default.

122 changes: 70 additions & 52 deletions cache/github.ae/webhook-events-and-payloads.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions payload-examples/api.github.com/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@
},
"check_run[check_suite][pull_requests]": {
"type": "array",
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`. \n \n**Note:**\n\n* The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n* When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
},
"check_run[check_suite][deployment]": {
"type": "object",
Expand Down Expand Up @@ -2953,7 +2953,7 @@
},
"check_suite[pull_requests]": {
"type": "array",
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`. \n \n**Note:**\n\n* The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n* When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
},
"repository": {
"type": "object",
Expand Down Expand Up @@ -54191,7 +54191,7 @@
},
{
"name": "repository_vulnerability_alert",
"description": "Activity related to security vulnerability alerts in a repository. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[About alerts for vulnerable dependencies](https://docs.github.com/en/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)\".",
"description": "Activity related to security vulnerability alerts in a repository. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[About Dependabot alerts](https://docs.github.com/en/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)\".",
"actions": ["create", "dismiss", "resolve"],
"properties": {
"alert": {
Expand Down Expand Up @@ -54824,7 +54824,7 @@
},
{
"name": "security_advisory",
"description": "Activity related to a security advisory that has been reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nThe security advisory dataset also powers the GitHub Dependabot alerts. For more information, see \"[About alerts for vulnerable dependencies](https://docs.github.com/en/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).\"",
"description": "Activity related to a security advisory that has been reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nThe security advisory dataset also powers the GitHub Dependabot alerts. For more information, see \"[About Dependabot alerts](https://docs.github.com/en/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).\"",
"actions": ["performed", "published", "updated", "withdrawn"],
"properties": {
"security_advisory": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@
"before": { "type": ["string", "null"] },
"after": { "type": ["string", "null"] },
"pull_requests": {
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`. \n \n**Note:**\n\n* The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n* When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
"type": "array",
"items": { "$ref": "common/check-run-pull-request.schema.json" }
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
"details_url": { "type": "string", "format": "uri" },
"status": {
"type": "string",
"enum": ["queued", "in_progress", "completed"],
"enum": ["queued", "in_progress", "completed", "waiting"],
"description": "The current status of the check run. Can be `queued`, `in_progress`, or `completed`."
},
"conclusion": {
Expand Down Expand Up @@ -133,7 +133,7 @@
"after": { "type": ["string", "null"] },
"pull_requests": {
"type": "array",
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`. \n \n**Note:**\n\n* The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n* When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
"items": { "$ref": "common/check-run-pull-request.schema.json" }
},
"deployment": { "$ref": "common/check-run-deployment.schema.json" },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@
},
"status": {
"type": "string",
"enum": ["queued", "in_progress", "completed"]
"enum": ["queued", "in_progress", "completed", "waiting"]
},
"conclusion": {
"type": ["string", "null"],
Expand All @@ -139,7 +139,7 @@
"after": { "type": ["string", "null"] },
"pull_requests": {
"type": "array",
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`. \n \n**Note:**\n\n* The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n* When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
"items": { "$ref": "common/check-run-pull-request.schema.json" }
},
"deployment": { "$ref": "common/check-run-deployment.schema.json" },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
"before": { "type": ["string", "null"] },
"after": { "type": ["string", "null"] },
"pull_requests": {
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`. \n \n**Note:**\n\n* The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n* When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
"type": "array",
"items": { "$ref": "common/check-run-pull-request.schema.json" }
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
"timed_out",
"action_required",
"stale",
"skipped",
null
]
},
Expand Down Expand Up @@ -105,7 +106,7 @@
"run_number": { "type": "integer" },
"status": {
"type": "string",
"enum": ["requested", "in_progress", "completed", "queued"]
"enum": ["requested", "in_progress", "completed", "queued", "waiting"]
},
"updated_at": { "type": "string", "format": "date-time" },
"url": { "type": "string", "format": "uri" },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
"details_url": { "type": "string", "format": "uri" },
"status": {
"type": "string",
"enum": ["queued", "in_progress", "completed"],
"enum": ["queued", "in_progress", "completed", "waiting"],
"description": "The current status of the check run. Can be `queued`, `in_progress`, or `completed`."
},
"conclusion": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
"cancelled",
"timed_out",
"action_required",
"stale"
"stale",
"skipped"
]
}
},
Expand Down
40 changes: 31 additions & 9 deletions payload-types/schema.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -743,7 +743,12 @@ export interface CheckRunCompletedEvent {
before: string | null;
after: string | null;
/**
* An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
* An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.
*
* **Note:**
*
* * The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.
* * When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
*/
pull_requests: CheckRunPullRequest[];
deployment?: CheckRunDeployment;
Expand Down Expand Up @@ -941,7 +946,7 @@ export interface CheckRunCreatedEvent {
/**
* The current status of the check run. Can be `queued`, `in_progress`, or `completed`.
*/
status: "queued" | "in_progress" | "completed";
status: "queued" | "in_progress" | "completed" | "waiting";
/**
* The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.
*/
Expand Down Expand Up @@ -999,7 +1004,12 @@ export interface CheckRunCreatedEvent {
before: string | null;
after: string | null;
/**
* An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
* An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.
*
* **Note:**
*
* * The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.
* * When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
*/
pull_requests: CheckRunPullRequest[];
deployment?: CheckRunDeployment;
Expand Down Expand Up @@ -1091,7 +1101,7 @@ export interface CheckRunRequestedActionEvent {
* The SHA of the head commit that is being checked.
*/
head_sha: string;
status: "queued" | "in_progress" | "completed";
status: "queued" | "in_progress" | "completed" | "waiting";
conclusion:
| "success"
| "failure"
Expand All @@ -1105,7 +1115,12 @@ export interface CheckRunRequestedActionEvent {
before: string | null;
after: string | null;
/**
* An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
* An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.
*
* **Note:**
*
* * The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.
* * When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
*/
pull_requests: CheckRunPullRequest[];
deployment?: CheckRunDeployment;
Expand Down Expand Up @@ -1210,7 +1225,12 @@ export interface CheckRunRerequestedEvent {
before: string | null;
after: string | null;
/**
* An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
* An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.
*
* **Note:**
*
* * The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.
* * When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
*/
pull_requests: CheckRunPullRequest[];
deployment?: CheckRunDeployment;
Expand Down Expand Up @@ -2211,7 +2231,7 @@ export interface DeploymentStatusCreatedEvent {
/**
* The current status of the check run. Can be `queued`, `in_progress`, or `completed`.
*/
status: "queued" | "in_progress" | "completed";
status: "queued" | "in_progress" | "completed" | "waiting";
/**
* The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.
*/
Expand Down Expand Up @@ -6198,7 +6218,8 @@ export interface WorkflowRunCompletedEvent {
| "cancelled"
| "timed_out"
| "action_required"
| "stale";
| "stale"
| "skipped";
};
installation?: InstallationLite;
}
Expand All @@ -6216,6 +6237,7 @@ export interface WorkflowRun {
| "timed_out"
| "action_required"
| "stale"
| "skipped"
| null;
created_at: string;
event: string;
Expand Down Expand Up @@ -6247,7 +6269,7 @@ export interface WorkflowRun {
repository: RepositoryLite;
rerun_url: string;
run_number: number;
status: "requested" | "in_progress" | "completed" | "queued";
status: "requested" | "in_progress" | "completed" | "queued" | "waiting";
updated_at: string;
url: string;
workflow_id: number;
Expand Down