feat: updates to workflow_job, repository_vulnerability_alert, `c…

…heck_suite`, `deployment`, `deployment_status` events (#604) * fix: remove `started` action from `workflow_job` * feat: new `alert[node_id]` property on `repository_vulnerability_alert#create` * feat: new `runs_rerequestable` property on `check_suite` * fix: add `string` type to `after_id` in the common `project-card` schema * fix: add `date-time` format to the `update_at` and `created_at` properties in `workflow` common schema * fix: remove `pull_request` override in `issue_comment` event schemas * feat: new `workflow` property on `deployment_status` event * feat: add new `deployment` and `deployment_status` payloads for a GH Pages deployment
octokit · Jan 23, 2022 · 6a1d98e · 6a1d98e
1 parent be7f17c
commit 6a1d98e
Show file tree

Hide file tree

Showing 16 changed files with 819 additions and 321 deletions.
diff --git a/...ob/started.with-organization.payload.json → ...thub.com/deployment/gh-pages.payload.json b/...ob/started.with-organization.payload.json → ...thub.com/deployment/gh-pages.payload.json
@@ -1,35 +1,76 @@
 {
-  "action": "started",
-  "workflow_job": {
+  "deployment": {
+    "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746",
+    "id": 145988746,
+    "node_id": "MDEwOkRlcGxveW1lbnQxNDU5ODg3NDY=",
+    "task": "deploy",
+    "original_environment": "github-pages",
+    "environment": "github-pages",
+    "description": null,
+    "created_at": "2022-01-03T01:28:30Z",
+    "updated_at": "2022-01-03T01:28:40Z",
+    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746/statuses",
+    "repository_url": "https://api.github.com/repos/Codertocat/Hello-World",
+    "creator": {
+      "login": "github-pages[bot]",
+      "id": 52472962,
+      "node_id": "MDM6Qm90NTI0NzI5NjI=",
+      "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/github-pages%5Bbot%5D",
+      "html_url": "https://github.com/apps/github-pages",
+      "followers_url": "https://api.github.com/users/github-pages%5Bbot%5D/followers",
+      "following_url": "https://api.github.com/users/github-pages%5Bbot%5D/following{/other_user}",
+      "gists_url": "https://api.github.com/users/github-pages%5Bbot%5D/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/github-pages%5Bbot%5D/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/github-pages%5Bbot%5D/subscriptions",
+      "organizations_url": "https://api.github.com/users/github-pages%5Bbot%5D/orgs",
+      "repos_url": "https://api.github.com/users/github-pages%5Bbot%5D/repos",
+      "events_url": "https://api.github.com/users/github-pages%5Bbot%5D/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/github-pages%5Bbot%5D/received_events",
+      "type": "Bot",
+      "site_admin": false
+    },
+    "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
+    "ref": "gh-pages",
+    "payload": {},
+    "transient_environment": false,
+    "production_environment": false,
+    "performed_via_github_app": null
+  },
+  "action": "created",
+  "workflow": {
+    "id": 17248323,
+    "node_id": "W_kwDOALyme84BBzBD",
+    "name": "pages-build-deployment",
+    "path": "dynamic/pages/pages-build-deployment",
+    "state": "active",
+    "created_at": "2022-01-03T01:27:48.000Z",
+    "updated_at": "2022-01-03T01:27:48.000Z",
+    "url": "https://api.github.com/repos/Codertocat/Hello-World/actions/workflows/17248323",
+    "html_url": "https://github.com/Codertocat/Hello-World/blob/master/dynamic/pages/pages-build-deployment",
+    "badge_url": "https://github.com/Codertocat/Hello-World/workflows/pages-build-deployment/badge.svg"
+  },
+  "workflow_run": {
     "id": 289782451,
-    "run_id": 2202229078,
-    "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1291536064",
-    "run_attempt": 1,
-    "node_id": "MDExOldvcmtmbG93UnVuMjg5NzgyNDUx",
-    "head_sha": "3484a3fb816e0859fd6e1cea078d76385ff50625",
-    "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/1291536064",
-    "html_url": "https://github.com/octo-org/octo-repo/runs/1291536064",
+    "name": "pages build and deployment",
+    "node_id": "WFR_kwLOALyme85iNFsT",
+    "head_branch": "gh-pages",
+    "head_sha": "9e602444f49b8b69c3a9a51fa97a115f3d323508",
+    "run_number": 1,
+    "event": "dynamic",
     "status": "in_progress",
     "conclusion": null,
-    "started_at": "2021-08-05T10:34:58Z",
-    "completed_at": null,
-    "name": "tests",
-    "steps": [
-      {
-        "name": "Set up job",
-        "status": "in_progress",
-        "conclusion": null,
-        "number": 1,
-        "started_at": "2021-08-05T10:26:08.000Z",
-        "completed_at": null
-      }
-    ],
-    "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/1291536064",
-    "labels": ["ubuntu-latest"],
-    "runner_id": 5,
-    "runner_name": "GitHub Actions 5",
-    "runner_group_id": 2,
-    "runner_group_name": "GitHub Actions"
+    "workflow_id": 17248323,
+    "check_suite_id": 4812750241,
+    "check_suite_node_id": "CS_kwDOALyme88AAAABHty9oQ",
+    "url": "https://api.github.com/repos/Codertocat/Hello-World/actions/runs/289782451",
+    "html_url": "https://github.com/Codertocat/Hello-World/actions/runs/289782451",
+    "pull_requests": [],
+    "created_at": "2022-01-03T01:27:48Z",
+    "updated_at": "2022-01-03T01:28:40Z",
+    "run_attempt": 1,
+    "run_started_at": "2022-01-03T01:27:48Z"
   },
   "repository": {
     "id": 186853002,
@@ -38,23 +79,23 @@
     "full_name": "Codertocat/Hello-World",
     "private": false,
     "owner": {
-      "login": "Octocoders",
-      "id": 38302899,
-      "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
+      "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/Octocoders",
-      "html_url": "https://github.com/Octocoders",
-      "followers_url": "https://api.github.com/users/Octocoders/followers",
-      "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
-      "organizations_url": "https://api.github.com/users/Octocoders/orgs",
-      "repos_url": "https://api.github.com/users/Octocoders/repos",
-      "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Octocoders/received_events",
-      "type": "Organization",
+      "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
     },
     "html_url": "https://github.com/Codertocat/Hello-World",
@@ -98,8 +139,8 @@
     "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
     "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
     "created_at": "2019-05-15T15:19:25Z",
-    "updated_at": "2019-05-15T15:19:27Z",
-    "pushed_at": "2019-05-15T15:20:32Z",
+    "updated_at": "2019-05-15T15:20:41Z",
+    "pushed_at": "2019-05-15T15:20:52Z",
     "git_url": "git://github.com/Codertocat/Hello-World.git",
     "ssh_url": "[email protected]:Codertocat/Hello-World.git",
     "clone_url": "https://github.com/Codertocat/Hello-World.git",
@@ -108,19 +149,19 @@
     "size": 0,
     "stargazers_count": 0,
     "watchers_count": 0,
-    "language": null,
+    "language": "Ruby",
     "has_issues": true,
     "has_projects": true,
     "has_downloads": true,
     "has_wiki": true,
     "has_pages": true,
-    "forks_count": 0,
+    "forks_count": 1,
     "mirror_url": null,
     "archived": false,
     "disabled": false,
     "open_issues_count": 2,
     "license": null,
-    "forks": 0,
+    "forks": 1,
     "open_issues": 2,
     "watchers": 0,
     "default_branch": "master",
@@ -161,5 +202,9 @@
     "received_events_url": "https://api.github.com/users/Codertocat/received_events",
     "type": "User",
     "site_admin": false
+  },
+  "installation": {
+    "id": 1,
+    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ=="
   }
 }