feat: new merge_group event (#681)

* fix: description updates for `ProjectsV2Items` * feat: new `merge_group` event schema Co-authored-by: wolfy1339 <webmaster@wolfy1339.com>
octokit · Aug 8, 2022 · d1d975e · d1d975e
1 parent 6142829
commit d1d975e
Show file tree

Hide file tree

Showing 14 changed files with 1,852 additions and 1,821 deletions.
diff --git a/cache/api.github.com/webhook-events-and-payloads.html b/cache/api.github.com/webhook-events-and-payloads.html
diff --git a/cache/ghes-32/webhook-events-and-payloads.html b/cache/ghes-32/webhook-events-and-payloads.html
diff --git a/cache/ghes-33/webhook-events-and-payloads.html b/cache/ghes-33/webhook-events-and-payloads.html
diff --git a/cache/ghes-34/webhook-events-and-payloads.html b/cache/ghes-34/webhook-events-and-payloads.html
diff --git a/cache/ghes-35/webhook-events-and-payloads.html b/cache/ghes-35/webhook-events-and-payloads.html
diff --git a/cache/github.ae/webhook-events-and-payloads.html b/cache/github.ae/webhook-events-and-payloads.html
diff --git a/payload-examples/api.github.com/index.json b/payload-examples/api.github.com/index.json
@@ -29516,6 +29516,184 @@
       }
     ]
   },
+  {
+    "name": "merge_group",
+    "description": "Activity related to merge groups in a merge queue. The type of activity is specified in the action property of the payload object.",
+    "properties": {
+      "merge_group": { "type": "object", "description": "The merge group." },
+      "merge_group[head_sha]": {
+        "type": "string",
+        "description": "The SHA of the merge group."
+      },
+      "merge_group[head_ref]": {
+        "type": "string",
+        "description": "The full ref of the merge group."
+      },
+      "merge_group[base_ref]": {
+        "type": "string",
+        "description": "The full ref of the branch the merge group will be merged into."
+      },
+      "repository": {
+        "type": "object",
+        "description": "The [`repository`](https://docs.github.com/en/rest/reference/repos#get-a-repository) where the event occurred."
+      },
+      "organization": {
+        "type": "object",
+        "description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/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."
+      },
+      "installation": {
+        "type": "object",
+        "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
+      },
+      "sender": {
+        "type": "object",
+        "description": "The user that triggered the event."
+      }
+    },
+    "actions": ["checks_requested"],
+    "examples": [
+      {
+        "action": "checks_requested",
+        "merge_group": {
+          "head_sha": "2ffea6db159f6b6c47a24e778fb9ef40cf6b1c7d",
+          "head_ref": "refs/heads/gh-readonly-queue/main/pr-104-929f8209d40f77f4abc622a499c93a83babdbe64",
+          "base_ref": "refs/heads/main"
+        },
+        "repository": {
+          "id": 17273051,
+          "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==",
+          "name": "octo-repo",
+          "full_name": "octo-org/octo-repo",
+          "private": true,
+          "owner": {
+            "login": "octo-org",
+            "id": 6811672,
+            "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
+            "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
+            "gravatar_id": "",
+            "url": "https://api.github.com/users/octo-org",
+            "html_url": "https://github.com/octo-org",
+            "followers_url": "https://api.github.com/users/octo-org/followers",
+            "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
+            "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
+            "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
+            "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
+            "organizations_url": "https://api.github.com/users/octo-org/orgs",
+            "repos_url": "https://api.github.com/users/octo-org/repos",
+            "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
+            "received_events_url": "https://api.github.com/users/octo-org/received_events",
+            "type": "Organization",
+            "site_admin": false
+          },
+          "html_url": "https://github.com/octo-org/octo-repo",
+          "description": "My first repo on GitHub!",
+          "fork": false,
+          "url": "https://api.github.com/repos/octo-org/octo-repo",
+          "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
+          "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
+          "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
+          "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
+          "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
+          "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
+          "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
+          "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
+          "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
+          "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
+          "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
+          "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
+          "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
+          "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
+          "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
+          "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
+          "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
+          "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
+          "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
+          "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
+          "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
+          "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
+          "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
+          "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
+          "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
+          "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
+          "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
+          "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
+          "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
+          "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
+          "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
+          "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
+          "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
+          "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
+          "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
+          "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
+          "created_at": "2014-02-28T02:42:51Z",
+          "updated_at": "2021-03-11T14:54:13Z",
+          "pushed_at": "2021-03-11T14:54:10Z",
+          "git_url": "git://github.com/octo-org/octo-repo.git",
+          "ssh_url": "org-6811672@github.com:octo-org/octo-repo.git",
+          "clone_url": "https://github.com/octo-org/octo-repo.git",
+          "svn_url": "https://github.com/octo-org/octo-repo",
+          "homepage": "",
+          "size": 300,
+          "stargazers_count": 0,
+          "watchers_count": 0,
+          "language": "JavaScript",
+          "has_issues": true,
+          "has_projects": false,
+          "has_downloads": true,
+          "has_wiki": false,
+          "has_pages": true,
+          "forks_count": 0,
+          "mirror_url": null,
+          "archived": false,
+          "disabled": false,
+          "open_issues_count": 39,
+          "license": null,
+          "forks": 0,
+          "open_issues": 39,
+          "watchers": 0,
+          "default_branch": "main"
+        },
+        "organization": {
+          "login": "octo-org",
+          "id": 6811672,
+          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
+          "url": "https://api.github.com/orgs/octo-org",
+          "repos_url": "https://api.github.com/orgs/octo-org/repos",
+          "events_url": "https://api.github.com/orgs/octo-org/events",
+          "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
+          "issues_url": "https://api.github.com/orgs/octo-org/issues",
+          "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
+          "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
+          "avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
+          "description": "Working better together!"
+        },
+        "sender": {
+          "login": "Codertocat",
+          "id": 21031067,
+          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+          "gravatar_id": "",
+          "url": "https://api.github.com/users/Codertocat",
+          "html_url": "https://github.com/Codertocat",
+          "followers_url": "https://api.github.com/users/Codertocat/followers",
+          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+          "repos_url": "https://api.github.com/users/Codertocat/repos",
+          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+          "type": "User",
+          "site_admin": false
+        },
+        "installation": {
+          "id": 1,
+          "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI="
+        }
+      }
+    ]
+  },
   {
     "name": "meta",
     "description": "The webhook this event is configured on was deleted. This event will only listen for changes to the particular hook the event is installed on. Therefore, it must be selected for each hook that you'd like to receive meta events for.",
@@ -32751,7 +32929,7 @@
   },
   {
     "name": "project",
-    "description": "Activity related to project boards. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[projects](https://docs.github.com/en/rest/reference/projects)\" REST API.",
+    "description": "Activity related to classic projects. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[projects](https://docs.github.com/en/rest/reference/projects)\" REST API.",
     "actions": ["closed", "created", "deleted", "edited", "reopened"],
     "properties": {
       "changes": {
@@ -33257,7 +33435,7 @@
   },
   {
     "name": "project_card",
-    "description": "Activity related to project cards. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[project cards](https://docs.github.com/en/rest/reference/projects#cards)\" REST API.",
+    "description": "Activity related to cards in a classic project. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[project cards](https://docs.github.com/en/rest/reference/projects#cards)\" REST API.",
     "actions": ["converted", "created", "deleted", "edited", "moved"],
     "properties": {
       "changes": {
@@ -34717,7 +34895,7 @@
   },
   {
     "name": "project_column",
-    "description": "Activity related to columns in a project board. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[project columns](https://docs.github.com/en/rest/reference/projects#columns)\" REST API.",
+    "description": "Activity related to columns in a classic project. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[project columns](https://docs.github.com/en/rest/reference/projects#columns)\" REST API.",
     "actions": ["created", "deleted", "edited", "moved"],
     "properties": {
       "changes": {
@@ -35283,7 +35461,7 @@
   },
   {
     "name": "projects_v2_item",
-    "description": "Activity related to items in a Projects (beta) project. The type of activity is specified in the `action` property of the payload object. For more information, see \"[About projects (beta)](https://docs.github.com/en/issues/trying-out-the-new-projects-experience/about-projects).\"",
+    "description": "Activity related to items in a project. The type of activity is specified in the `action` property of the payload object. For more information, see \"[About projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"",
     "actions": [
       "archived",
       "converted",
@@ -35296,7 +35474,7 @@
     "properties": {
       "projects_v2_item": {
         "type": "object",
-        "description": "The project item itself. To find more information about the project item, you can use `node_id` (the node ID of the project item) and `project_node_id` (the node ID of the project) to query information in the GraphQL API. For more information, see \"[Using the API to manage projects (beta)](https://docs.github.com/en/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects).\""
+        "description": "The project item itself. To find more information about the project item, you can use `node_id` (the node ID of the project item) and `project_node_id` (the node ID of the project) to query information in the GraphQL API. For more information, see \"[Using the API to manage projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects).\""
       },
       "changes": {
         "type": "object",

diff --git a/payload-examples/ghes-32/index.json b/payload-examples/ghes-32/index.json
@@ -5500,7 +5500,7 @@
   },
   {
     "name": "project_card",
-    "description": "Activity related to project cards. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[project cards](https://docs.github.com/en/enterprise-server@3.2/rest/reference/projects#cards)\" REST API.",
+    "description": "Activity related to cards in a project board. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[project cards](https://docs.github.com/en/enterprise-server@3.2/rest/reference/projects#cards)\" REST API.",
     "properties": {
       "changes": {
         "type": "object",