feat: new referenced_workflow property on workflow_run

octokit · Jul 5, 2022 · 6d11ea9 · 6d11ea9
1 parent 623d0a7
commit 6d11ea9
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 1 deletion.
diff --git a/payload-schemas/api.github.com/common/deployment-workflow-run.schema.json b/payload-schemas/api.github.com/common/deployment-workflow-run.schema.json
@@ -65,7 +65,11 @@
     "actor": { "$ref": "user.schema.json" },
     "triggering_actor": { "$ref": "user.schema.json" },
     "run_attempt": { "type": "integer" },
-    "run_started_at": { "type": "string", "format": "date-time" }
+    "run_started_at": { "type": "string", "format": "date-time" },
+    "referenced_workflows": {
+      "type": "array",
+      "items": { "$ref": "referenced-workflow.schema.json" }
+    }
   },
   "additionalProperties": false,
   "title": "Deployment Workflow Run"

diff --git a/payload-schemas/api.github.com/common/referenced-workflow.schema.json b/payload-schemas/api.github.com/common/referenced-workflow.schema.json
@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "common/referenced-workflow.schema.json",
+  "title": "Referenced workflow",
+  "description": "A workflow referenced/reused by the initial caller workflow",
+  "type": "object",
+  "properties": {
+    "path": { "type": "string" },
+    "sha": { "type": "string" },
+    "ref": { "type": "string" }
+  },
+  "required": ["path", "sha"],
+  "additionalProperties": false
+}
diff --git a/payload-schemas/api.github.com/common/workflow-run.schema.json b/payload-schemas/api.github.com/common/workflow-run.schema.json
@@ -114,6 +114,10 @@
     "workflow_id": { "type": "integer" },
     "workflow_url": { "type": "string", "format": "uri" },
     "run_attempt": { "type": "integer" },
+    "referenced_workflows": {
+      "type": "array",
+      "items": { "$ref": "referenced-workflow.schema.json" }
+    },
     "run_started_at": { "type": "string", "format": "date-time" },
     "previous_attempt_url": {
       "oneOf": [{ "type": "string", "format": "uri" }, { "type": "null" }]