Skip to content

Commit b591210

Browse files
feat: octokit.actions.downloadWorkflow{Job,Run}logs, octokit.apps.{suspend,unsuspend}Installation. Deprecates octokit.actions.listWorkflow{Job,Run}Logs (#75)
Co-authored-by: Octokit Bot <33075676+octokitbot@users.noreply.github.com>
1 parent c8c9573 commit b591210

Some content is hidden

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

50 files changed

+594
-176
lines changed

docs/actions/cancelWorkflowRun.md

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

99
# Cancel a workflow run
1010

11-
Cancels a workflow run using its `id`. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
11+
Cancels a workflow run using its `id`. Anyone with write access to the repository and an access token with the `repo` scope can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
1212

1313
```js
1414
octokit.actions.cancelWorkflowRun({

docs/actions/createOrUpdateSecretForRepo.md

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

99
# Create or update a secret for a repository
1010

11-
Creates or updates a secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.
11+
Creates or updates a secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). Anyone with write access to the repository and an access token with the `repo` scope can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.
1212

1313
Encrypt your secret using the [tweetsodium](https://github.com/mastahyeti/tweetsodium) library.
1414

docs/actions/createRegistrationToken.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ type: API method
1010

1111
**Deprecated:** This method has been renamed to actions.createRegistrationTokenForRepo
1212

13-
Returns a token that you can pass to the `config` script. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration:write` repository permission to use this endpoint.
13+
Returns a token that you can pass to the `config` script. The token expires after one hour. Anyone with admin access to the repository and an access token with the `repo` scope can use this endpoint.
1414

1515
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
1616

docs/actions/createRegistrationTokenForOrg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ type: API method
1010

1111
**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
1212

13-
Returns a token that you can pass to the `config` script. The token expires after one hour. Anyone with admin access to the organization can use this endpoint. GitHub Apps must have the `self-hosted runners:write` organization permission to use this endpoint.
13+
Returns a token that you can pass to the `config` script. The token expires after one hour. Anyone with admin access to the organization can use this endpoint.
1414

1515
Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.
1616

docs/actions/createRegistrationTokenForRepo.md

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

99
# Create a registration token for a repository
1010

11-
Returns a token that you can pass to the `config` script. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration:write` repository permission to use this endpoint.
11+
Returns a token that you can pass to the `config` script. The token expires after one hour. Anyone with admin access to the repository and an access token with the `repo` scope can use this endpoint.
1212

1313
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
1414

docs/actions/createRemoveToken.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ type: API method
1010

1111
**Deprecated:** This method has been renamed to actions.createRemoveTokenForRepo
1212

13-
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration:write` repository permission to use this endpoint.
13+
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. Anyone with admin access to the repository and an access token with the `repo` scope can use this endpoint.
1414

1515
Remove your self-hosted runner from a repository, replacing TOKEN with the remove token provided by this endpoint.
1616

docs/actions/createRemoveTokenForOrg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ type: API method
1010

1111
**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
1212

13-
Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. Anyone with admin access to the organization can use this endpoint. GitHub Apps must have the `self-hosted runners:write` organization permission to use this endpoint.
13+
Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. Anyone with admin access to the organization can use this endpoint.
1414

1515
To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this endpoint.
1616

docs/actions/createRemoveTokenForRepo.md

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

99
# Create a remove token for a repository
1010

11-
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration:write` repository permission to use this endpoint.
11+
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. Anyone with admin access to the repository and an access token with the `repo` scope can use this endpoint.
1212

1313
Remove your self-hosted runner from a repository, replacing TOKEN with the remove token provided by this endpoint.
1414

docs/actions/deleteArtifact.md

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

99
# Delete an artifact
1010

11-
Deletes an artifact for a workflow run. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
11+
Deletes an artifact for a workflow run. Anyone with write access to the repository and an access token with the `repo` scope can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
1212

1313
```js
1414
octokit.actions.deleteArtifact({

docs/actions/deleteSecretFromRepo.md

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

99
# Delete a secret from a repository
1010

11-
Deletes a secret in a repository using the secret name. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.
11+
Deletes a secret in a repository using the secret name. Anyone with write access to the repository and an access token with the `repo` scope can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.
1212

1313
```js
1414
octokit.actions.deleteSecretFromRepo({

0 commit comments

Comments
 (0)