From f36b3dd3477bc74f146ee0d3124b14f0bbbac2d3 Mon Sep 17 00:00:00 2001 From: Octokit Bot Date: Wed, 8 Jun 2022 22:52:35 +0000 Subject: [PATCH 1/7] build: cache --- .../webhook-events-and-payloads.html | 133 ++---------------- 1 file changed, 12 insertions(+), 121 deletions(-) diff --git a/cache/api.github.com/webhook-events-and-payloads.html b/cache/api.github.com/webhook-events-and-payloads.html index e5742451e..335be6277 100644 --- a/cache/api.github.com/webhook-events-and-payloads.html +++ b/cache/api.github.com/webhook-events-and-payloads.html @@ -4,17 +4,7 @@

Webhook events and payloads

payload contains more detailed information.

Note: Payloads are capped at 25 MB. If your event @@ -1680,16 +1661,7 @@

>" REST API.

Note: The Checks API only looks for pushes in the @@ -2323,16 +2295,7 @@

>" REST API.

Note: The Checks API only looks for pushes in the @@ -3560,16 +3523,7 @@

>" REST API.

Note: You will not receive a webhook for this event @@ -3902,16 +3856,7 @@

>" REST API.

Note: You will not receive a webhook for this event @@ -5257,16 +5202,7 @@

>discussion

Note: Webhook events for GitHub Discussions are @@ -5639,16 +5575,7 @@

>discussion_comment

Note: Webhook events for GitHub Discussions are @@ -11821,16 +11748,7 @@

Note: This event does not occur for Projects (beta). @@ -12199,16 +12117,7 @@

Note: This event does not occur for Projects (beta). @@ -12880,16 +12789,7 @@

>projects_v2_item

Note: Webhook events for Projects (beta) are @@ -16259,16 +16159,7 @@

One or more commits are pushed to a repository branch or tag.

Note: You will not receive a webhook for this event From 1371f6b0b03d6d2d474a9e91f23ab611d794c65f Mon Sep 17 00:00:00 2001 From: wolfy1339 Date: Wed, 8 Jun 2022 18:54:05 -0400 Subject: [PATCH 2/7] fix: add missing title to `ProjectsV2Item` --- .../api.github.com/common/projects_v2_item.schema.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/payload-schemas/api.github.com/common/projects_v2_item.schema.json b/payload-schemas/api.github.com/common/projects_v2_item.schema.json index 03d0a5575..fdd0f4a1b 100644 --- a/payload-schemas/api.github.com/common/projects_v2_item.schema.json +++ b/payload-schemas/api.github.com/common/projects_v2_item.schema.json @@ -28,5 +28,6 @@ "updated_at": { "type": "string", "format": "date-time" }, "archived_at": { "type": ["string", "null"], "format": "date-time" } }, - "additionalProperties": false + "additionalProperties": false, + "title": "Projects v2 Item" } From a859146c56da7e09283d083118f4ffa89ee38790 Mon Sep 17 00:00:00 2001 From: wolfy1339 Date: Wed, 8 Jun 2022 18:55:49 -0400 Subject: [PATCH 3/7] fix(GHES3.1): description updates --- payload-examples/ghes-31/index.json | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/payload-examples/ghes-31/index.json b/payload-examples/ghes-31/index.json index 3dede03bb..781dc29a5 100644 --- a/payload-examples/ghes-31/index.json +++ b/payload-examples/ghes-31/index.json @@ -243,7 +243,7 @@ }, "ref_type": { "type": "string", - "description": "The type of Git ref oject deleted in the repository. Can be `branch` or `tag`." + "description": "The type of Git ref object deleted in the repository. Can be either `branch` or `tag`." }, "pusher_type": { "type": "string", @@ -1656,7 +1656,32 @@ { "name": "workflow_dispatch", "description": "This event occurs when someone triggers a workflow run on GitHub or sends a `POST` request to the \"[Create a workflow dispatch event](https://docs.github.com/en/enterprise-server@3.1/rest/reference/actions/#create-a-workflow-dispatch-event)\" endpoint. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/enterprise-server@3.1/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"", - "properties": {}, + "properties": { + "inputs": { + "type": "object", + "description": "Inputs to the workflow. Each key represents the name of the input while it's value represents the value of that input." + }, + "organization": { + "type": "object", + "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.1/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + }, + "ref": { + "type": "string", + "description": "The branch ref from which the workflow was run." + }, + "repository": { + "type": "object", + "description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.1/rest/reference/repos#get-a-repository) where the event occurred." + }, + "sender": { + "type": "object", + "description": "The user that triggered the event." + }, + "workflow": { + "type": "string", + "description": "Relative path to the workflow file which contains the workflow." + } + }, "actions": [], "examples": [] }, From 94341b1ae2b5b51b30ed6305a5c7f298d41eaf7c Mon Sep 17 00:00:00 2001 From: wolfy1339 Date: Wed, 8 Jun 2022 18:55:58 -0400 Subject: [PATCH 4/7] fix(GHES3.2): description updates --- payload-examples/ghes-32/index.json | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/payload-examples/ghes-32/index.json b/payload-examples/ghes-32/index.json index 8bfb1bee1..2ff2aa3a8 100644 --- a/payload-examples/ghes-32/index.json +++ b/payload-examples/ghes-32/index.json @@ -243,7 +243,7 @@ }, "ref_type": { "type": "string", - "description": "The type of Git ref oject deleted in the repository. Can be `branch` or `tag`." + "description": "The type of Git ref object deleted in the repository. Can be either `branch` or `tag`." }, "pusher_type": { "type": "string", @@ -1656,7 +1656,32 @@ { "name": "workflow_dispatch", "description": "This event occurs when someone triggers a workflow run on GitHub or sends a `POST` request to the \"[Create a workflow dispatch event](https://docs.github.com/en/enterprise-server@3.2/rest/reference/actions/#create-a-workflow-dispatch-event)\" endpoint. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/enterprise-server@3.2/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"", - "properties": {}, + "properties": { + "inputs": { + "type": "object", + "description": "Inputs to the workflow. Each key represents the name of the input while it's value represents the value of that input." + }, + "organization": { + "type": "object", + "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.2/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + }, + "ref": { + "type": "string", + "description": "The branch ref from which the workflow was run." + }, + "repository": { + "type": "object", + "description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.2/rest/reference/repos#get-a-repository) where the event occurred." + }, + "sender": { + "type": "object", + "description": "The user that triggered the event." + }, + "workflow": { + "type": "string", + "description": "Relative path to the workflow file which contains the workflow." + } + }, "actions": [], "examples": [] }, From 2a8a4861d9448b4a7bb96abf8df18cb2a6904abe Mon Sep 17 00:00:00 2001 From: wolfy1339 Date: Wed, 8 Jun 2022 18:56:08 -0400 Subject: [PATCH 5/7] fix(GHES3.3): description updates --- payload-examples/ghes-33/index.json | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/payload-examples/ghes-33/index.json b/payload-examples/ghes-33/index.json index f8b9ea522..d03eb0f26 100644 --- a/payload-examples/ghes-33/index.json +++ b/payload-examples/ghes-33/index.json @@ -271,7 +271,7 @@ }, "ref_type": { "type": "string", - "description": "The type of Git ref oject deleted in the repository. Can be `branch` or `tag`." + "description": "The type of Git ref object deleted in the repository. Can be either `branch` or `tag`." }, "pusher_type": { "type": "string", @@ -1684,7 +1684,32 @@ { "name": "workflow_dispatch", "description": "This event occurs when someone triggers a workflow run on GitHub or sends a `POST` request to the \"[Create a workflow dispatch event](https://docs.github.com/en/enterprise-server@3.3/rest/reference/actions/#create-a-workflow-dispatch-event)\" endpoint. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/enterprise-server@3.3/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"", - "properties": {}, + "properties": { + "inputs": { + "type": "object", + "description": "Inputs to the workflow. Each key represents the name of the input while it's value represents the value of that input." + }, + "organization": { + "type": "object", + "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + }, + "ref": { + "type": "string", + "description": "The branch ref from which the workflow was run." + }, + "repository": { + "type": "object", + "description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred." + }, + "sender": { + "type": "object", + "description": "The user that triggered the event." + }, + "workflow": { + "type": "string", + "description": "Relative path to the workflow file which contains the workflow." + } + }, "actions": [], "examples": [] }, From b367678d108fb2db9023594ee0cd9b96afb7cd65 Mon Sep 17 00:00:00 2001 From: wolfy1339 Date: Wed, 8 Jun 2022 18:56:20 -0400 Subject: [PATCH 6/7] fix(GHAE): description updates --- payload-examples/github.ae/index.json | 50 ++++++++++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/payload-examples/github.ae/index.json b/payload-examples/github.ae/index.json index a8d38b760..0e89da83f 100644 --- a/payload-examples/github.ae/index.json +++ b/payload-examples/github.ae/index.json @@ -2296,7 +2296,7 @@ }, "ref_type": { "type": "string", - "description": "The type of Git ref oject deleted in the repository. Can be `branch` or `tag`." + "description": "The type of Git ref object deleted in the repository. Can be either `branch` or `tag`." }, "pusher_type": { "type": "string", @@ -15533,5 +15533,53 @@ } } ] + }, + { + "name": "workflow_job", + "description": "A GitHub Actions workflow job has been queued, is in progress, or has been completed on a repository. The type of activity is specified in the `action` property of the payload object.", + "properties": { + "workflow_job": { + "type": "object", + "description": "The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object." + }, + "workflow_job[status]": { + "type": "string", + "description": "The current status of the job. Can be `queued`, `in_progress`, or `completed`." + }, + "workflow_job[labels]": { + "type": "array", + "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/en/github-ae@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML." + }, + "workflow_job[runner_id]": { + "type": "integer", + "description": "The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`." + }, + "workflow_job[runner_name]": { + "type": "string", + "description": "The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`." + }, + "workflow_job[runner_group_id]": { + "type": "integer", + "description": "The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`." + }, + "workflow_job[runner_group_name]": { + "type": "string", + "description": "The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`." + }, + "repository": { + "type": "object", + "description": "The [`repository`](https://docs.github.com/en/github-ae@latest/rest/reference/repos#get-a-repository) where the event occurred." + }, + "organization": { + "type": "object", + "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/github-ae@latest/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization." + }, + "sender": { + "type": "object", + "description": "The user that triggered the event." + } + }, + "actions": ["completed", "in_progress", "queued"], + "examples": [] } ] From 6a80fd7f576a4cbd72012627cfd596389fba42fe Mon Sep 17 00:00:00 2001 From: wolfy1339 Date: Wed, 8 Jun 2022 18:58:05 -0400 Subject: [PATCH 7/7] fix:(api.github.com): description updates --- .../api.github.com/workflow_dispatch/event.schema.json | 5 ++++- payload-types/schema.d.ts | 3 +++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/payload-schemas/api.github.com/workflow_dispatch/event.schema.json b/payload-schemas/api.github.com/workflow_dispatch/event.schema.json index d5f8180df..e6d207c54 100644 --- a/payload-schemas/api.github.com/workflow_dispatch/event.schema.json +++ b/payload-schemas/api.github.com/workflow_dispatch/event.schema.json @@ -19,7 +19,10 @@ "sender": { "$ref": "common/user.schema.json" }, "installation": { "$ref": "common/installation-lite.schema.json" }, "organization": { "$ref": "common/organization.schema.json" }, - "workflow": { "type": "string" } + "workflow": { + "description": "Relative path to the workflow file which contains the workflow.", + "type": "string" + } }, "additionalProperties": false, "title": "workflow_dispatch event" diff --git a/payload-types/schema.d.ts b/payload-types/schema.d.ts index 5ad0cbcae..472e47232 100644 --- a/payload-types/schema.d.ts +++ b/payload-types/schema.d.ts @@ -6209,6 +6209,9 @@ export interface WorkflowDispatchEvent { sender: User; installation?: InstallationLite; organization?: Organization; + /** + * Relative path to the workflow file which contains the workflow. + */ workflow: string; } export interface WorkflowJobCompletedEvent {