Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/actions/cancelWorkflowRun.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ run_id parameter
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/workflow_runs/#cancel-a-workflow-run).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/workflow-runs/#cancel-a-workflow-run).
8 changes: 5 additions & 3 deletions docs/actions/createRegistrationToken.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Create a registration token
# Create a registration token for a repository

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` permission to use this endpoint.
**Deprecated:** This method has been renamed to actions.createRegistrationTokenForRepo

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.

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

Expand Down Expand Up @@ -35,4 +37,4 @@ repo parameter
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self_hosted_runners/#create-a-registration-token).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#create-a-registration-token-for-a-repository).
34 changes: 34 additions & 0 deletions docs/actions/createRegistrationTokenForOrg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Create a registration token for an organization

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

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.

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

```js
octokit.actions.createRegistrationTokenForOrg({
org,
});
```

## Parameters

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

org parameter

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

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#create-a-registration-token-for-an-organization).
38 changes: 38 additions & 0 deletions docs/actions/createRegistrationTokenForRepo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Create a registration token for a repository

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.

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

```js
octokit.actions.createRegistrationTokenForRepo({
owner,
repo,
});
```

## Parameters

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

owner parameter

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

repo parameter

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

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#create-a-registration-token-for-a-repository).
8 changes: 5 additions & 3 deletions docs/actions/createRemoveToken.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Create a remove token
# Create a remove token for a repository

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` permission to use this endpoint.
**Deprecated:** This method has been renamed to actions.createRemoveTokenForRepo

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.

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

Expand Down Expand Up @@ -35,4 +37,4 @@ repo parameter
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self_hosted_runners/#create-a-remove-token).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#create-a-remove-token-for-a-repository).
34 changes: 34 additions & 0 deletions docs/actions/createRemoveTokenForOrg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Create a remove token for an organization

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

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.

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

```js
octokit.actions.createRemoveTokenForOrg({
org,
});
```

## Parameters

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

org parameter

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

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#create-a-remove-token-for-an-organization).
38 changes: 38 additions & 0 deletions docs/actions/createRemoveTokenForRepo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Create a remove token for a repository

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.

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

```js
octokit.actions.createRemoveTokenForRepo({
owner,
repo,
});
```

## Parameters

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

owner parameter

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

repo parameter

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

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#create-a-remove-token-for-a-repository).
38 changes: 38 additions & 0 deletions docs/actions/deleteSelfHostedRunnerFromOrg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Delete a self-hosted runner from an organization

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

Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. 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.

```js
octokit.actions.deleteSelfHostedRunnerFromOrg({
org,
runner_id,
});
```

## Parameters

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

org parameter

</td></tr>
<tr><td>runner_id</td><td>yes</td><td>

runner_id parameter

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

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#delete-a-self-hosted-runner-from-an-organization).
42 changes: 42 additions & 0 deletions docs/actions/deleteSelfHostedRunnerFromRepo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Delete a self-hosted runner from a repository

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. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration:write` repository permission to use this endpoint.

```js
octokit.actions.deleteSelfHostedRunnerFromRepo({
owner,
repo,
runner_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>

owner parameter

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

repo parameter

</td></tr>
<tr><td>runner_id</td><td>yes</td><td>

runner_id parameter

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

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#delete-a-self-hosted-runner-from-a-repository).
2 changes: 1 addition & 1 deletion docs/actions/deleteWorkflowRunLogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ run_id parameter
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/workflow_runs/#delete-workflow-run-logs).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/workflow-runs/#delete-workflow-run-logs).
8 changes: 5 additions & 3 deletions docs/actions/getSelfHostedRunner.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Get a self-hosted runner
# Get a self-hosted runner for a repository

Gets a specific self-hosted runner. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.
**Deprecated:** This method has been renamed to actions.getSelfHostedRunnerForRepo

Gets a specific self-hosted runner. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration:read` repository permission to use this endpoint.

```js
octokit.actions.getSelfHostedRunner({
Expand Down Expand Up @@ -39,4 +41,4 @@ runner_id parameter
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self_hosted_runners/#get-a-self-hosted-runner).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#get-a-self-hosted-runner-for-a-repository).
38 changes: 38 additions & 0 deletions docs/actions/getSelfHostedRunnerForOrg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Get a self-hosted runner for an organization

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

Gets a specific self-hosted runner for an organization. Anyone with admin access to the organization can use this endpoint. GitHub Apps must have the `self-hosted runners:read` organization permission to use this endpoint.

```js
octokit.actions.getSelfHostedRunnerForOrg({
org,
runner_id,
});
```

## Parameters

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

org parameter

</td></tr>
<tr><td>runner_id</td><td>yes</td><td>

runner_id parameter

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

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#get-a-self-hosted-runner-for-an-organization).
42 changes: 42 additions & 0 deletions docs/actions/getSelfHostedRunnerForRepo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Get a self-hosted runner for a repository

Gets a specific self-hosted runner. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration:read` repository permission to use this endpoint.

```js
octokit.actions.getSelfHostedRunnerForRepo({
owner,
repo,
runner_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>

owner parameter

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

repo parameter

</td></tr>
<tr><td>runner_id</td><td>yes</td><td>

runner_id parameter

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

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#get-a-self-hosted-runner-for-a-repository).
2 changes: 1 addition & 1 deletion docs/actions/getWorkflowJob.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ job_id parameter
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/workflow_jobs/#get-a-workflow-job).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/workflow-jobs/#get-a-workflow-job).
2 changes: 1 addition & 1 deletion docs/actions/getWorkflowRun.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ run_id parameter
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/workflow_runs/#get-a-workflow-run).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/workflow-runs/#get-a-workflow-run).
Loading