Skip to content

Commit

Permalink
feat: new /orgs/{org}/actions/runners/generate-jitconfig endpoint, …
Browse files Browse the repository at this point in the history
…and documentation updates (#645)
  • Loading branch information
octokitbot committed Jun 9, 2023
1 parent 917af29 commit e94662f
Show file tree
Hide file tree
Showing 454 changed files with 8,379 additions and 1,028 deletions.
2 changes: 1 addition & 1 deletion docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>runner_id</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/approveWorkflowRun.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>run_id</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/cancelWorkflowRun.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>run_id</td><td>yes</td><td>
Expand Down
8 changes: 4 additions & 4 deletions docs/actions/createOrUpdateEnvironmentSecret.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Creates or updates an environment secret with an encrypted value. Encrypt your s
token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use
this endpoint.

#### Example encrypting a secret using Node.js
**Example encrypting a secret using Node.js**

Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.

Expand All @@ -38,7 +38,7 @@ sodium.ready.then(() => {
});
```

#### Example encrypting a secret using Python
**Example encrypting a secret using Python**

Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.

Expand All @@ -54,7 +54,7 @@ def encrypt(public_key: str, secret_value: str) -> str:
return b64encode(encrypted).decode("utf-8")
```

#### Example encrypting a secret using C#
**Example encrypting a secret using C#**

Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.

Expand All @@ -67,7 +67,7 @@ var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey
Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
```

#### Example encrypting a secret using Ruby
**Example encrypting a secret using Ruby**

Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.

Expand Down
10 changes: 5 additions & 5 deletions docs/actions/createOrUpdateRepoSecret.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Creates or updates a repository secret with an encrypted value. Encrypt your sec
token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use
this endpoint.

#### Example encrypting a secret using Node.js
**Example encrypting a secret using Node.js**

Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.

Expand All @@ -38,7 +38,7 @@ sodium.ready.then(() => {
});
```

#### Example encrypting a secret using Python
**Example encrypting a secret using Python**

Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.

Expand All @@ -54,7 +54,7 @@ def encrypt(public_key: str, secret_value: str) -> str:
return b64encode(encrypted).decode("utf-8")
```

#### Example encrypting a secret using C#
**Example encrypting a secret using C#**

Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.

Expand All @@ -67,7 +67,7 @@ var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey
Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
```

#### Example encrypting a secret using Ruby
**Example encrypting a secret using Ruby**

Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.

Expand Down Expand Up @@ -111,7 +111,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>secret_name</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/createRegistrationTokenForRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/createRemoveTokenForRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/createRepoVariable.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>name</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/createWorkflowDispatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>workflow_id</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/deleteActionsCacheById.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>cache_id</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/deleteActionsCacheByKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>key</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/deleteArtifact.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>artifact_id</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/deleteRepoSecret.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>secret_name</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/deleteRepoVariable.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>name</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/deleteSelfHostedRunnerFromRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>runner_id</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/deleteWorkflowRun.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>run_id</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/deleteWorkflowRunLogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>run_id</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/disableWorkflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>workflow_id</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/downloadArtifact.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>artifact_id</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/downloadJobLogsForWorkflowRun.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>job_id</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/downloadWorkflowRunAttemptLogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>run_id</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/downloadWorkflowRunLogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>run_id</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/enableWorkflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The account owner of the repository. The name is not case sensitive.
</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.
The name of the repository without the `.git` extension. The name is not case sensitive.

</td></tr>
<tr><td>workflow_id</td><td>yes</td><td>
Expand Down
63 changes: 63 additions & 0 deletions docs/actions/generateRunnerJitconfigForOrg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
name: Create configuration for a just-in-time runner for an organization
example: octokit.rest.actions.generateRunnerJitconfigForOrg({ org, name, runner_group_id, labels })
route: POST /orgs/{org}/actions/runners/generate-jitconfig
scope: actions
type: API method
---

# Create configuration for a just-in-time runner for an organization

Generates a configuration that can be passed to the runner application at startup.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.

```js
octokit.rest.actions.generateRunnerJitconfigForOrg({
org,
name,
runner_group_id,
labels,
});
```

## Parameters

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

The organization name. The name is not case sensitive.

</td></tr>
<tr><td>name</td><td>yes</td><td>

The name of the new runner.

</td></tr>
<tr><td>runner_group_id</td><td>yes</td><td>

The ID of the runner group to register the runner to.

</td></tr>
<tr><td>labels</td><td>yes</td><td>

The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100.

</td></tr>
<tr><td>work_folder</td><td>no</td><td>

The working directory to be used for job execution, relative to the runner install directory.

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

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization).

0 comments on commit e94662f

Please sign in to comment.