Skip to content

Commit

Permalink
feat: octokit.rest.actions.retryWorkflow(). Deprecates `octokit.res…
Browse files Browse the repository at this point in the history
…t.actions.reRunWorkflow()` (#453)
  • Loading branch information
octokitbot authored Sep 22, 2021
1 parent f27909a commit 2e41527
Show file tree
Hide file tree
Showing 8 changed files with 17,394 additions and 52 deletions.
7 changes: 6 additions & 1 deletion docs/actions/reRunWorkflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@ type: API method

# Re-run a workflow

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.
**Deprecation Notice:** This endpoint is deprecated.
We recommend migrating your existing code to use the new [retry workflow](https://docs.github.com/rest/reference/actions#retry-a-workflow) endpoint.

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.

```js
octokit.rest.actions.reRunWorkflow({
Expand Down
46 changes: 46 additions & 0 deletions docs/actions/retryWorkflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Retry a workflow
example: octokit.rest.actions.retryWorkflow({ owner, repo, run_id })
route: POST /repos/{owner}/{repo}/actions/runs/{run_id}/retry
scope: actions
type: API method
---

# Retry a workflow

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.

```js
octokit.rest.actions.retryWorkflow({
owner,
repo,
run_id,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>owner</td><td>yes</td><td>

</td></tr>
<tr><td>repo</td><td>yes</td><td>

</td></tr>
<tr><td>run_id</td><td>yes</td><td>

The id of the workflow run.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#retry-a-workflow).
Loading

0 comments on commit 2e41527

Please sign in to comment.