Skip to content

Commit 8fc4146

Browse files
octokitbotoctokitbot
authored
feat: add support for new display_title attribute returned on workflow runs across the API (e.g. in GET /repos/{owner}/{repo}/actions/runs) (#247)
WIP
1 parent 4844e96 commit 8fc4146

File tree

21 files changed

+63
-17
lines changed

21 files changed

+63
-17
lines changed

‎cache/api.github.com.json

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.13.0",
4+
"version": "7.14.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -73227,13 +73227,19 @@
7322773227
"head_repository_id": {
7322873228
"type": "integer",
7322973229
"example": 5
73230+
},
73231+
"display_title": {
73232+
"type": "string",
73233+
"example": "Simple Workflow",
73234+
"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."
7323073235
}
7323173236
},
7323273237
"required": [
7323373238
"id",
7323473239
"node_id",
7323573240
"head_branch",
7323673241
"run_number",
73242+
"display_title",
7323773243
"event",
7323873244
"status",
7323973245
"conclusion",
@@ -97952,6 +97958,7 @@
9795297958
"path": ".github/workflows/build.yml@main",
9795397959
"run_number": 562,
9795497960
"event": "push",
97961+
"display_title": "Update README.md",
9795597962
"status": "queued",
9795697963
"conclusion": null,
9795797964
"workflow_id": 159038,

‎cache/ghes-3.2.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.13.0",
4+
"version": "7.14.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -61031,6 +61031,7 @@
6103161031
"node_id",
6103261032
"head_branch",
6103361033
"run_number",
61034+
"display_title",
6103461035
"event",
6103561036
"status",
6103661037
"conclusion",

‎cache/ghes-3.3.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.13.0",
4+
"version": "7.14.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -61724,6 +61724,7 @@
6172461724
"node_id",
6172561725
"head_branch",
6172661726
"run_number",
61727+
"display_title",
6172761728
"event",
6172861729
"status",
6172961730
"conclusion",

‎cache/ghes-3.4.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.13.0",
4+
"version": "7.14.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -63651,6 +63651,7 @@
6365163651
"node_id",
6365263652
"head_branch",
6365363653
"run_number",
63654+
"display_title",
6365463655
"event",
6365563656
"status",
6365663657
"conclusion",

‎cache/ghes-3.5.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.13.0",
4+
"version": "7.14.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -65493,6 +65493,7 @@
6549365493
"node_id",
6549465494
"head_branch",
6549565495
"run_number",
65496+
"display_title",
6549665497
"event",
6549765498
"status",
6549865499
"conclusion",

‎cache/ghes-3.6.json

+16-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.13.0",
4+
"version": "7.14.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -22436,7 +22436,13 @@
2243622436
"category": "actions",
2243722437
"subcategory": "workflow-runs"
2243822438
},
22439-
"x-octokit": {}
22439+
"x-octokit": {
22440+
"diff": {
22441+
"api.github.com": {
22442+
"type": "changed"
22443+
}
22444+
}
22445+
}
2244022446
},
2244122447
"delete": {
2244222448
"summary": "Delete a workflow run",
@@ -22653,7 +22659,13 @@
2265322659
"category": "actions",
2265422660
"subcategory": "workflow-runs"
2265522661
},
22656-
"x-octokit": {}
22662+
"x-octokit": {
22663+
"diff": {
22664+
"api.github.com": {
22665+
"type": "changed"
22666+
}
22667+
}
22668+
}
2265722669
}
2265822670
},
2265922671
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
@@ -70311,6 +70323,7 @@
7031170323
"node_id",
7031270324
"head_branch",
7031370325
"run_number",
70326+
"display_title",
7031470327
"event",
7031570328
"status",
7031670329
"conclusion",
@@ -92950,7 +92963,6 @@
9295092963
"run_number": 562,
9295192964
"event": "push",
9295292965
"status": "queued",
92953-
"conclusion": null,
9295492966
"workflow_id": 159038,
9295592967
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
9295692968
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",

‎cache/github.ae.json

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "7.13.0",
4+
"version": "7.14.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -62321,13 +62321,19 @@
6232162321
"head_repository_id": {
6232262322
"type": "integer",
6232362323
"example": 5
62324+
},
62325+
"display_title": {
62326+
"type": "string",
62327+
"example": "Simple Workflow",
62328+
"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."
6232462329
}
6232562330
},
6232662331
"required": [
6232762332
"id",
6232862333
"node_id",
6232962334
"head_branch",
6233062335
"run_number",
62336+
"display_title",
6233162337
"event",
6233262338
"status",
6233362339
"conclusion",
@@ -83213,6 +83219,7 @@
8321383219
"path": ".github/workflows/build.yml@main",
8321483220
"run_number": 562,
8321583221
"event": "push",
83222+
"display_title": "Update README.md",
8321683223
"status": "queued",
8321783224
"conclusion": null,
8321883225
"workflow_id": 159038,

‎packages/openapi-types-ghes-3.2/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
"author": "Gregor Martynus (https://twitter.com/gr2m)",
1616
"license": "MIT",
1717
"octokit": {
18-
"openapi-version": "7.13.0"
18+
"openapi-version": "7.14.0"
1919
}
2020
}

‎packages/openapi-types-ghes-3.2/types.d.ts

+1
Original file line numberDiff line numberDiff line change
@@ -10084,6 +10084,7 @@ export interface components {
1008410084
/** @example 5 */
1008510085
head_repository_id?: number;
1008610086
} & {
10087+
display_title: unknown;
1008710088
path: unknown;
1008810089
};
1008910090
/**

‎packages/openapi-types-ghes-3.3/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
"author": "Gregor Martynus (https://twitter.com/gr2m)",
1616
"license": "MIT",
1717
"octokit": {
18-
"openapi-version": "7.13.0"
18+
"openapi-version": "7.14.0"
1919
}
2020
}

‎packages/openapi-types-ghes-3.3/types.d.ts

+1
Original file line numberDiff line numberDiff line change
@@ -10637,6 +10637,7 @@ export interface components {
1063710637
/** @example 5 */
1063810638
head_repository_id?: number;
1063910639
} & {
10640+
display_title: unknown;
1064010641
path: unknown;
1064110642
};
1064210643
/**

‎packages/openapi-types-ghes-3.4/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
"author": "Gregor Martynus (https://twitter.com/gr2m)",
1616
"license": "MIT",
1717
"octokit": {
18-
"openapi-version": "7.13.0"
18+
"openapi-version": "7.14.0"
1919
}
2020
}

‎packages/openapi-types-ghes-3.4/types.d.ts

+1
Original file line numberDiff line numberDiff line change
@@ -11028,6 +11028,7 @@ export interface components {
1102811028
/** @example 5 */
1102911029
head_repository_id?: number;
1103011030
} & {
11031+
display_title: unknown;
1103111032
path: unknown;
1103211033
};
1103311034
/**

‎packages/openapi-types-ghes-3.5/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
"author": "Gregor Martynus (https://twitter.com/gr2m)",
1616
"license": "MIT",
1717
"octokit": {
18-
"openapi-version": "7.13.0"
18+
"openapi-version": "7.14.0"
1919
}
2020
}

‎packages/openapi-types-ghes-3.5/types.d.ts

+1
Original file line numberDiff line numberDiff line change
@@ -11405,6 +11405,7 @@ export interface components {
1140511405
/** @example 5 */
1140611406
head_repository_id?: number;
1140711407
} & {
11408+
display_title: unknown;
1140811409
path: unknown;
1140911410
};
1141011411
/**

‎packages/openapi-types-ghes-3.6/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
"author": "Gregor Martynus (https://twitter.com/gr2m)",
1616
"license": "MIT",
1717
"octokit": {
18-
"openapi-version": "7.13.0"
18+
"openapi-version": "7.14.0"
1919
}
2020
}

‎packages/openapi-types-ghes-3.6/types.d.ts

+2
Original file line numberDiff line numberDiff line change
@@ -12435,6 +12435,8 @@ export interface components {
1243512435
head_repository: components["schemas"]["minimal-repository"];
1243612436
/** @example 5 */
1243712437
head_repository_id?: number;
12438+
} & {
12439+
display_title: unknown;
1243812440
};
1243912441
/**
1244012442
* Environment Approval

‎packages/openapi-types-github.ae/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
"author": "Gregor Martynus (https://twitter.com/gr2m)",
1616
"license": "MIT",
1717
"octokit": {
18-
"openapi-version": "7.13.0"
18+
"openapi-version": "7.14.0"
1919
}
2020
}

‎packages/openapi-types-github.ae/types.d.ts

+5
Original file line numberDiff line numberDiff line change
@@ -10677,6 +10677,11 @@ export interface components {
1067710677
head_repository: components["schemas"]["minimal-repository"];
1067810678
/** @example 5 */
1067910679
head_repository_id?: number;
10680+
/**
10681+
* @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.
10682+
* @example Simple Workflow
10683+
*/
10684+
display_title: string;
1068010685
};
1068110686
/**
1068210687
* Workflow Run Usage

‎packages/openapi-types/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
"author": "Gregor Martynus (https://twitter.com/gr2m)",
1616
"license": "MIT",
1717
"octokit": {
18-
"openapi-version": "7.13.0"
18+
"openapi-version": "7.14.0"
1919
}
2020
}

‎packages/openapi-types/types.d.ts

+5
Original file line numberDiff line numberDiff line change
@@ -13801,6 +13801,11 @@ export interface components {
1380113801
head_repository: components["schemas"]["minimal-repository"];
1380213802
/** @example 5 */
1380313803
head_repository_id?: number;
13804+
/**
13805+
* @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.
13806+
* @example Simple Workflow
13807+
*/
13808+
display_title: string;
1380413809
};
1380513810
/**
1380613811
* Environment Approval

0 commit comments

Comments
 (0)