Skip to content

Commit 2e41527

Browse files
authored
feat: octokit.rest.actions.retryWorkflow(). Deprecates octokit.rest.actions.reRunWorkflow() (#453)
1 parent f27909a commit 2e41527

File tree

8 files changed

+17394
-52
lines changed

8 files changed

+17394
-52
lines changed

docs/actions/reRunWorkflow.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ type: API method
88

99
# Re-run a workflow
1010

11-
Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
11+
**Deprecation Notice:** This endpoint is deprecated.
12+
We recommend migrating your existing code to use the new [retry workflow](https://docs.github.com/rest/reference/actions#retry-a-workflow) endpoint.
13+
14+
Re-runs your workflow run using its `id`. You must authenticate using
15+
an access token with the `repo` scope to use this endpoint. GitHub Apps must have
16+
the `actions:write` permission to use this endpoint.
1217

1318
```js
1419
octokit.rest.actions.reRunWorkflow({

docs/actions/retryWorkflow.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Retry a workflow
3+
example: octokit.rest.actions.retryWorkflow({ owner, repo, run_id })
4+
route: POST /repos/{owner}/{repo}/actions/runs/{run_id}/retry
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Retry a workflow
10+
11+
Retry your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
12+
13+
```js
14+
octokit.rest.actions.retryWorkflow({
15+
owner,
16+
repo,
17+
run_id,
18+
});
19+
```
20+
21+
## Parameters
22+
23+
<table>
24+
<thead>
25+
<tr>
26+
<th>name</th>
27+
<th>required</th>
28+
<th>description</th>
29+
</tr>
30+
</thead>
31+
<tbody>
32+
<tr><td>owner</td><td>yes</td><td>
33+
34+
</td></tr>
35+
<tr><td>repo</td><td>yes</td><td>
36+
37+
</td></tr>
38+
<tr><td>run_id</td><td>yes</td><td>
39+
40+
The id of the workflow run.
41+
42+
</td></tr>
43+
</tbody>
44+
</table>
45+
46+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#retry-a-workflow).

0 commit comments

Comments
 (0)