Skip to content

Commit 212e1e9

Browse files
authored
feat: deprecate import endpoints, new octokit.rest.orgs.createOrUpdateCustomProperties(), octokit.rest.orgs.createOrUpdateCustomProperty(), octokit.rest.orgs.createOrUpdateCustomPropertiesValuesForRepos(), octokit.rest.actions.forceCancelWorkflowRun(), octokit.rest.orgs.getAllCustomProperties(), octokit.rest.orgs.getCustomProperty(), octokit.rest.orgs.listCustomPropertiesValuesForRepos(), octokit.rest.orgs.removeCustomProperty() methods, octokit.rest.orgs.removeCustomProperty()description updates (#687)
1 parent 3c7810c commit 212e1e9

File tree

91 files changed

+3430
-709
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+3430
-709
lines changed

docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ type: API method
1111
Add custom labels to a self-hosted runner configured in a repository.
1212

1313
You must authenticate using an access token with the `repo` scope to use this endpoint.
14-
If the repository is private, you must use an access token with the `repo` scope.
1514
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
1615
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
1716

docs/actions/cancelWorkflowRun.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ type: API method
1111
Cancels a workflow run using its `id`.
1212

1313
You must authenticate using an access token with the `repo` scope to use this endpoint.
14-
If the repository is private, you must use an access token with the `repo` scope.
1514
GitHub Apps must have the `actions:write` permission to use this endpoint.
1615

1716
```js

docs/actions/createEnvironmentVariable.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ type: API method
1111
Create an environment variable that you can reference in a GitHub Actions workflow.
1212

1313
You must authenticate using an access token with the `repo` scope to use this endpoint.
14-
If the repository is private, you must use an access token with the `repo` scope.
1514
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
1615
Authenticated users must have collaborator access to a repository to create, update, or read variables.
1716

docs/actions/createRegistrationTokenForRepo.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Returns a token that you can pass to the `config` script. The token
1212
expires after one hour.
1313

1414
You must authenticate using an access token with the `repo` scope to use this endpoint.
15-
If the repository is private, you must use an access token with the `repo` scope.
1615
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
1716
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
1817

docs/actions/createRemoveTokenForRepo.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Returns a token that you can pass to remove a self-hosted runner from
1212
a repository. The token expires after one hour.
1313

1414
You must authenticate using an access token with the `repo` scope to use this endpoint.
15-
If the repository is private, you must use an access token with the `repo` scope.
1615
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
1716
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
1817

docs/actions/createRepoVariable.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ type: API method
1111
Creates a repository variable that you can reference in a GitHub Actions workflow.
1212

1313
You must authenticate using an access token with the `repo` scope to use this endpoint.
14-
If the repository is private, you must use an access token with the `repo` scope.
1514
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
1615
Authenticated users must have collaborator access to a repository to create, update, or read variables.
1716

docs/actions/deleteEnvironmentVariable.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ type: API method
1111
Deletes an environment variable using the variable name.
1212

1313
You must authenticate using an access token with the `repo` scope to use this endpoint.
14-
If the repository is private, you must use an access token with the `repo` scope.
1514
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
1615
Authenticated users must have collaborator access to a repository to create, update, or read variables.
1716

docs/actions/deleteRepoVariable.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ type: API method
1111
Deletes a repository variable using the variable name.
1212

1313
You must authenticate using an access token with the `repo` scope to use this endpoint.
14-
If the repository is private, you must use an access token with the `repo` scope.
1514
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
1615
Authenticated users must have collaborator access to a repository to create, update, or read variables.
1716

docs/actions/deleteSelfHostedRunnerFromRepo.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ type: API method
1111
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
1212

1313
You must authenticate using an access token with the `repo` scope to use this endpoint.
14-
If the repository is private, you must use an access token with the `repo` scope.
1514
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
1615
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
1716

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
name: Force cancel a workflow run
3+
example: octokit.rest.actions.forceCancelWorkflowRun({ owner, repo, run_id })
4+
route: POST /repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Force cancel a workflow run
10+
11+
Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
12+
You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).
13+
14+
You must authenticate using an access token with the `repo` scope to use this endpoint.
15+
GitHub Apps must have the `actions:write` permission to use this endpoint.
16+
17+
```js
18+
octokit.rest.actions.forceCancelWorkflowRun({
19+
owner,
20+
repo,
21+
run_id,
22+
});
23+
```
24+
25+
## Parameters
26+
27+
<table>
28+
<thead>
29+
<tr>
30+
<th>name</th>
31+
<th>required</th>
32+
<th>description</th>
33+
</tr>
34+
</thead>
35+
<tbody>
36+
<tr><td>owner</td><td>yes</td><td>
37+
38+
The account owner of the repository. The name is not case sensitive.
39+
40+
</td></tr>
41+
<tr><td>repo</td><td>yes</td><td>
42+
43+
The name of the repository without the `.git` extension. The name is not case sensitive.
44+
45+
</td></tr>
46+
<tr><td>run_id</td><td>yes</td><td>
47+
48+
The unique identifier of the workflow run.
49+
50+
</td></tr>
51+
</tbody>
52+
</table>
53+
54+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run).

0 commit comments

Comments
 (0)