feat: add support for new display_title attribute returned on workf…

…low runs across the API (e.g. in `GET /repos/{owner}/{repo}/actions/runs`) (#247) WIP
octokit · Sep 16, 2022 · 8fc4146 · 8fc4146
1 parent 4844e96
commit 8fc4146
Show file tree

Hide file tree

Showing 21 changed files with 63 additions and 17 deletions.
diff --git a/cache/api.github.com.json b/cache/api.github.com.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.13.0",
+ "version": "7.14.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -73227,13 +73227,19 @@
  "head_repository_id": {
  "type": "integer",
  "example": 5
+ },
+ "display_title": {
+ "type": "string",
+ "example": "Simple Workflow",
+ "description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow."
  }
  },
  "required": [
  "id",
  "node_id",
  "head_branch",
  "run_number",
+ "display_title",
  "event",
  "status",
  "conclusion",
@@ -97952,6 +97958,7 @@
  "path": ".github/workflows/build.yml@main",
  "run_number": 562,
  "event": "push",
+ "display_title": "Update README.md",
  "status": "queued",
  "conclusion": null,
  "workflow_id": 159038,

diff --git a/cache/ghes-3.2.json b/cache/ghes-3.2.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.13.0",
+ "version": "7.14.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -61031,6 +61031,7 @@
  "node_id",
  "head_branch",
  "run_number",
+ "display_title",
  "event",
  "status",
  "conclusion",

diff --git a/cache/ghes-3.3.json b/cache/ghes-3.3.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.13.0",
+ "version": "7.14.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -61724,6 +61724,7 @@
  "node_id",
  "head_branch",
  "run_number",
+ "display_title",
  "event",
  "status",
  "conclusion",

diff --git a/cache/ghes-3.4.json b/cache/ghes-3.4.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.13.0",
+ "version": "7.14.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -63651,6 +63651,7 @@
  "node_id",
  "head_branch",
  "run_number",
+ "display_title",
  "event",
  "status",
  "conclusion",

diff --git a/cache/ghes-3.5.json b/cache/ghes-3.5.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.13.0",
+ "version": "7.14.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -65493,6 +65493,7 @@
  "node_id",
  "head_branch",
  "run_number",
+ "display_title",
  "event",
  "status",
  "conclusion",

diff --git a/cache/ghes-3.6.json b/cache/ghes-3.6.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.13.0",
+ "version": "7.14.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -22436,7 +22436,13 @@
  "category": "actions",
  "subcategory": "workflow-runs"
  },
- "x-octokit": {}
+ "x-octokit": {
+ "diff": {
+ "api.github.com": {
+ "type": "changed"
+ }
+ }
+ }
  },
  "delete": {
  "summary": "Delete a workflow run",
@@ -22653,7 +22659,13 @@
  "category": "actions",
  "subcategory": "workflow-runs"
  },
- "x-octokit": {}
+ "x-octokit": {
+ "diff": {
+ "api.github.com": {
+ "type": "changed"
+ }
+ }
+ }
  }
  },
  "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
@@ -70311,6 +70323,7 @@
  "node_id",
  "head_branch",
  "run_number",
+ "display_title",
  "event",
  "status",
  "conclusion",
@@ -92950,7 +92963,6 @@
  "run_number": 562,
  "event": "push",
  "status": "queued",
- "conclusion": null,
  "workflow_id": 159038,
  "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
  "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",

diff --git a/cache/github.ae.json b/cache/github.ae.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.13.0",
+ "version": "7.14.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -62321,13 +62321,19 @@
  "head_repository_id": {
  "type": "integer",
  "example": 5
+ },
+ "display_title": {
+ "type": "string",
+ "example": "Simple Workflow",
+ "description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow."
  }
  },
  "required": [
  "id",
  "node_id",
  "head_branch",
  "run_number",
+ "display_title",
  "event",
  "status",
  "conclusion",
@@ -83213,6 +83219,7 @@
  "path": ".github/workflows/build.yml@main",
  "run_number": 562,
  "event": "push",
+ "display_title": "Update README.md",
  "status": "queued",
  "conclusion": null,
  "workflow_id": 159038,

diff --git a/packages/openapi-types-ghes-3.2/package.json b/packages/openapi-types-ghes-3.2/package.json
@@ -15,6 +15,6 @@
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
  "octokit": {
- "openapi-version": "7.13.0"
+ "openapi-version": "7.14.0"
  }
 }
diff --git a/packages/openapi-types-ghes-3.2/types.d.ts b/packages/openapi-types-ghes-3.2/types.d.ts
@@ -10084,6 +10084,7 @@ export interface components {
  /** @example 5 */
  head_repository_id?: number;
  } & {
+ display_title: unknown;
  path: unknown;
  };
  /**

diff --git a/packages/openapi-types-ghes-3.3/package.json b/packages/openapi-types-ghes-3.3/package.json
@@ -15,6 +15,6 @@
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
  "octokit": {
- "openapi-version": "7.13.0"
+ "openapi-version": "7.14.0"
  }
 }
diff --git a/packages/openapi-types-ghes-3.3/types.d.ts b/packages/openapi-types-ghes-3.3/types.d.ts
@@ -10637,6 +10637,7 @@ export interface components {
  /** @example 5 */
  head_repository_id?: number;
  } & {
+ display_title: unknown;
  path: unknown;
  };
  /**

diff --git a/packages/openapi-types-ghes-3.4/package.json b/packages/openapi-types-ghes-3.4/package.json
@@ -15,6 +15,6 @@
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
  "octokit": {
- "openapi-version": "7.13.0"
+ "openapi-version": "7.14.0"
  }
 }
diff --git a/packages/openapi-types-ghes-3.4/types.d.ts b/packages/openapi-types-ghes-3.4/types.d.ts
@@ -11028,6 +11028,7 @@ export interface components {
  /** @example 5 */
  head_repository_id?: number;
  } & {
+ display_title: unknown;
  path: unknown;
  };
  /**

diff --git a/packages/openapi-types-ghes-3.5/package.json b/packages/openapi-types-ghes-3.5/package.json
@@ -15,6 +15,6 @@
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
  "octokit": {
- "openapi-version": "7.13.0"
+ "openapi-version": "7.14.0"
  }
 }
diff --git a/packages/openapi-types-ghes-3.5/types.d.ts b/packages/openapi-types-ghes-3.5/types.d.ts
@@ -11405,6 +11405,7 @@ export interface components {
  /** @example 5 */
  head_repository_id?: number;
  } & {
+ display_title: unknown;
  path: unknown;
  };
  /**

diff --git a/packages/openapi-types-ghes-3.6/package.json b/packages/openapi-types-ghes-3.6/package.json
@@ -15,6 +15,6 @@
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
  "octokit": {
- "openapi-version": "7.13.0"
+ "openapi-version": "7.14.0"
  }
 }
diff --git a/packages/openapi-types-ghes-3.6/types.d.ts b/packages/openapi-types-ghes-3.6/types.d.ts
@@ -12435,6 +12435,8 @@ export interface components {
  head_repository: components["schemas"]["minimal-repository"];
  /** @example 5 */
  head_repository_id?: number;
+ } & {
+ display_title: unknown;
  };
  /**
  * Environment Approval

diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json
@@ -15,6 +15,6 @@
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
  "octokit": {
- "openapi-version": "7.13.0"
+ "openapi-version": "7.14.0"
  }
 }
diff --git a/packages/openapi-types-github.ae/types.d.ts b/packages/openapi-types-github.ae/types.d.ts
@@ -10677,6 +10677,11 @@ export interface components {
  head_repository: components["schemas"]["minimal-repository"];
  /** @example 5 */
  head_repository_id?: number;
+ /**
+ * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow.
+ * @example Simple Workflow
+ */
+ display_title: string;
  };
  /**
  * Workflow Run Usage

diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json
@@ -15,6 +15,6 @@
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
  "octokit": {
- "openapi-version": "7.13.0"
+ "openapi-version": "7.14.0"
  }
 }
diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts
@@ -13801,6 +13801,11 @@ export interface components {
  head_repository: components["schemas"]["minimal-repository"];
  /** @example 5 */
  head_repository_id?: number;
+ /**
+ * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow.
+ * @example Simple Workflow
+ */
+ display_title: string;
  };
  /**
  * Environment Approval