Repository navigation
Expand file tree
/
Copy pathapi.ts
More file actions
146 lines (127 loc) · 4.57 KB
/
Copy pathapi.ts
File metadata and controls
146 lines (127 loc) · 4.57 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
import * as core from "@actions/core";
import * as github from "@actions/github";
import { type ActionConfig, getConfig } from "./action.ts";
type Octokit = ReturnType<typeof github.getOctokit>;
let config: ActionConfig;
let octokit: Octokit;
export function init(cfg?: ActionConfig): void {
config = cfg ?? getConfig();
octokit = github.getOctokit(config.token);
}
/**
* The version that returns the created run. The default `2022-11-28` answers
* 204 with no body and reports the endpoint as deprecated on every request.
*
* Served by github.com and GHES 3.21 or newer.
*
* See: https://docs.github.com/en/rest/about-the-rest-api/api-versions
*/
const API_VERSION = "2026-03-10";
/**
* The 200 response body of the workflow dispatch endpoint.
*
* Declared locally because `@octokit/openapi-types` still types this endpoint
* as 204-only, so the shape is validated at runtime instead.
*
* See: https://docs.github.com/en/rest/actions/workflows#create-a-workflow-dispatch-event--status-codes
*/
interface WorkflowDispatchResponse {
workflow_run_id: number;
run_url: string;
html_url: string;
}
/**
* Identifies the run created by a dispatch.
*/
export interface DispatchedWorkflowRun {
id: number;
url: string;
}
function readDispatchedRun(data: unknown): DispatchedWorkflowRun | undefined {
if (typeof data !== "object" || data === null) {
return undefined;
}
const { workflow_run_id: id, html_url: url } =
data as Partial<WorkflowDispatchResponse>;
if (typeof id !== "number" || typeof url !== "string") {
return undefined;
}
return { id, url };
}
const RUN_DETAILS_UNSUPPORTED =
"Dispatch did not return the run details, this action requires github.com or GHES >=3.21";
/**
* Servers without `API_VERSION` reject the request with a 400 rather than
* falling back, so the empty 204 path is never reached on them. Lead with
* the original message and add the requirement as a hint, since a 400 can
* also be an ordinary bad request on a supported server.
*
* Matching on the status alone is deliberate. The 400 message shape is
* undocumented and may differ between GHES versions.
*/
function asUnsupportedRunDetailsError(error: unknown): Error | undefined {
if (!(error instanceof Error) || !("status" in error)) {
return undefined;
}
if (error.status !== 400) {
return undefined;
}
return new Error(
`Dispatch was rejected with a 400: ${error.message}. ` +
`If the server is GitHub Enterprise Server older than 3.21, it does not support API version ${API_VERSION}, which this action requires to return the run details`,
{ cause: error },
);
}
/**
* Dispatch the workflow and return the run that it created.
*
* Throws if the server does not report the run details, which requires
* github.com or GitHub Enterprise Server 3.21 or newer.
*/
export async function dispatchWorkflow(): Promise<DispatchedWorkflowRun> {
try {
// https://docs.github.com/en/rest/actions/workflows#create-a-workflow-dispatch-event
const response = await octokit.rest.actions.createWorkflowDispatch({
owner: config.owner,
repo: config.repo,
workflow_id: config.workflow,
ref: config.ref,
inputs: config.workflowInputs,
headers: { "x-github-api-version": API_VERSION },
});
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
if (!(response.status == 204 || response.status == 200)) {
throw new Error(
`Failed to dispatch action, expected 200 or 204 but received ${response.status}`,
);
}
const dispatchedRun = readDispatchedRun(response.data);
if (dispatchedRun === undefined) {
// Unlike the 400 path, the dispatch itself has succeeded here.
throw new Error(
`${RUN_DETAILS_UNSUPPORTED}. The workflow was dispatched but its run cannot be identified`,
);
}
core.info(
"Successfully dispatched workflow:\n" +
` Repository: ${config.owner}/${config.repo}\n` +
` Branch: ${config.ref}\n` +
` Workflow: ${config.workflow}\n` +
(config.workflowInputs
? ` Workflow Inputs: ${JSON.stringify(config.workflowInputs)}\n`
: ``) +
` Run ID: ${dispatchedRun.id}\n` +
` Run URL: ${dispatchedRun.url}`,
);
return dispatchedRun;
} catch (error) {
const reportedError = asUnsupportedRunDetailsError(error) ?? error;
if (reportedError instanceof Error) {
core.error(
`dispatchWorkflow: An unexpected error has occurred: ${reportedError.message}`,
);
core.debug(reportedError.stack ?? "");
}
throw reportedError;
}
}