Skip to content

Commit b3fe977

Browse files
octokitbotoctokitbot
authored
feat: new /enterprises/{enterprise}/actions/hosted-runners, /orgs/{org}/actions/hosted-runners, /orgs/{org}/settings/network-configurations, /orgs/{org}/rulesets/{ruleset_id}/history,/repos/{owner}/{repo}/rulesets/{ruleset_id}/history endpoints (#791)
1 parent 4177570 commit b3fe977

File tree

95 files changed

+4548
-545
lines changed

Some content is hidden

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

95 files changed

+4548
-545
lines changed

‎docs/actions/createHostedRunnerForOrg.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
name: Create a GitHub-hosted runner for an organization
3+
example: octokit.rest.actions.createHostedRunnerForOrg({ org, name, image, size, runner_group_id })
4+
route: POST /orgs/{org}/actions/hosted-runners
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Create a GitHub-hosted runner for an organization
10+
11+
Creates a GitHub-hosted runner for an organization.
12+
OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
13+
14+
```js
15+
octokit.rest.actions.createHostedRunnerForOrg({
16+
org,
17+
name,
18+
image,
19+
size,
20+
runner_group_id,
21+
});
22+
```
23+
24+
## Parameters
25+
26+
<table>
27+
<thead>
28+
<tr>
29+
<th>name</th>
30+
<th>required</th>
31+
<th>description</th>
32+
</tr>
33+
</thead>
34+
<tbody>
35+
<tr><td>org</td><td>yes</td><td>
36+
37+
The organization name. The name is not case sensitive.
38+
39+
</td></tr>
40+
<tr><td>name</td><td>yes</td><td>
41+
42+
Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '\_'.
43+
44+
</td></tr>
45+
<tr><td>image</td><td>yes</td><td>
46+
47+
The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.
48+
49+
</td></tr>
50+
<tr><td>image.id</td><td>no</td><td>
51+
52+
The unique identifier of the runner image.
53+
54+
</td></tr>
55+
<tr><td>image.source</td><td>no</td><td>
56+
57+
The source of the runner image.
58+
59+
</td></tr>
60+
<tr><td>size</td><td>yes</td><td>
61+
62+
The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`
63+
64+
</td></tr>
65+
<tr><td>runner_group_id</td><td>yes</td><td>
66+
67+
The existing runner group to add this runner to.
68+
69+
</td></tr>
70+
<tr><td>maximum_runners</td><td>no</td><td>
71+
72+
The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.
73+
74+
</td></tr>
75+
<tr><td>enable_static_ip</td><td>no</td><td>
76+
77+
Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`
78+
79+
</td></tr>
80+
</tbody>
81+
</table>
82+
83+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization).

‎docs/actions/createOrUpdateRepoSecret.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Create or update a repository secret
3-
example: octokit.rest.actions.createOrUpdateRepoSecret({ owner, repo, secret_name })
3+
example: octokit.rest.actions.createOrUpdateRepoSecret({ owner, repo, secret_name, encrypted_value, key_id })
44
route: PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}
55
scope: actions
66
type: API method
@@ -20,6 +20,8 @@ octokit.rest.actions.createOrUpdateRepoSecret({
2020
owner,
2121
repo,
2222
secret_name,
23+
encrypted_value,
24+
key_id,
2325
});
2426
```
2527

@@ -49,12 +51,12 @@ The name of the repository without the `.git` extension. The name is not case se
4951
The name of the secret.
5052

5153
</td></tr>
52-
<tr><td>encrypted_value</td><td>no</td><td>
54+
<tr><td>encrypted_value</td><td>yes</td><td>
5355

5456
Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint.
5557

5658
</td></tr>
57-
<tr><td>key_id</td><td>no</td><td>
59+
<tr><td>key_id</td><td>yes</td><td>
5860

5961
ID of the key you used to encrypt the secret.
6062

‎docs/actions/deleteHostedRunnerForOrg.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Delete a GitHub-hosted runner for an organization
3+
example: octokit.rest.actions.deleteHostedRunnerForOrg({ org, hosted_runner_id })
4+
route: DELETE /orgs/{org}/actions/hosted-runners/{hosted_runner_id}
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Delete a GitHub-hosted runner for an organization
10+
11+
Deletes a GitHub-hosted runner for an organization.
12+
13+
```js
14+
octokit.rest.actions.deleteHostedRunnerForOrg({
15+
org,
16+
hosted_runner_id,
17+
});
18+
```
19+
20+
## Parameters
21+
22+
<table>
23+
<thead>
24+
<tr>
25+
<th>name</th>
26+
<th>required</th>
27+
<th>description</th>
28+
</tr>
29+
</thead>
30+
<tbody>
31+
<tr><td>org</td><td>yes</td><td>
32+
33+
The organization name. The name is not case sensitive.
34+
35+
</td></tr>
36+
<tr><td>hosted_runner_id</td><td>yes</td><td>
37+
38+
Unique identifier of the GitHub-hosted runner.
39+
40+
</td></tr>
41+
</tbody>
42+
</table>
43+
44+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization).

‎docs/actions/getHostedRunnerForOrg.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Get a GitHub-hosted runner for an organization
3+
example: octokit.rest.actions.getHostedRunnerForOrg({ org, hosted_runner_id })
4+
route: GET /orgs/{org}/actions/hosted-runners/{hosted_runner_id}
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Get a GitHub-hosted runner for an organization
10+
11+
Gets a GitHub-hosted runner configured in an organization.
12+
13+
OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
14+
15+
```js
16+
octokit.rest.actions.getHostedRunnerForOrg({
17+
org,
18+
hosted_runner_id,
19+
});
20+
```
21+
22+
## Parameters
23+
24+
<table>
25+
<thead>
26+
<tr>
27+
<th>name</th>
28+
<th>required</th>
29+
<th>description</th>
30+
</tr>
31+
</thead>
32+
<tbody>
33+
<tr><td>org</td><td>yes</td><td>
34+
35+
The organization name. The name is not case sensitive.
36+
37+
</td></tr>
38+
<tr><td>hosted_runner_id</td><td>yes</td><td>
39+
40+
Unique identifier of the GitHub-hosted runner.
41+
42+
</td></tr>
43+
</tbody>
44+
</table>
45+
46+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization).

‎docs/actions/getHostedRunnersGithubOwnedImagesForOrg.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Get GitHub-owned images for GitHub-hosted runners in an organization
3+
example: octokit.rest.actions.getHostedRunnersGithubOwnedImagesForOrg({ org })
4+
route: GET /orgs/{org}/actions/hosted-runners/images/github-owned
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Get GitHub-owned images for GitHub-hosted runners in an organization
10+
11+
Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.
12+
13+
```js
14+
octokit.rest.actions.getHostedRunnersGithubOwnedImagesForOrg({
15+
org,
16+
});
17+
```
18+
19+
## Parameters
20+
21+
<table>
22+
<thead>
23+
<tr>
24+
<th>name</th>
25+
<th>required</th>
26+
<th>description</th>
27+
</tr>
28+
</thead>
29+
<tbody>
30+
<tr><td>org</td><td>yes</td><td>
31+
32+
The organization name. The name is not case sensitive.
33+
34+
</td></tr>
35+
</tbody>
36+
</table>
37+
38+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization).

‎docs/actions/getHostedRunnersLimitsForOrg.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Get limits on GitHub-hosted runners for an organization
3+
example: octokit.rest.actions.getHostedRunnersLimitsForOrg({ org })
4+
route: GET /orgs/{org}/actions/hosted-runners/limits
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Get limits on GitHub-hosted runners for an organization
10+
11+
Get the GitHub-hosted runners limits for an organization.
12+
13+
```js
14+
octokit.rest.actions.getHostedRunnersLimitsForOrg({
15+
org,
16+
});
17+
```
18+
19+
## Parameters
20+
21+
<table>
22+
<thead>
23+
<tr>
24+
<th>name</th>
25+
<th>required</th>
26+
<th>description</th>
27+
</tr>
28+
</thead>
29+
<tbody>
30+
<tr><td>org</td><td>yes</td><td>
31+
32+
The organization name. The name is not case sensitive.
33+
34+
</td></tr>
35+
</tbody>
36+
</table>
37+
38+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization).

‎docs/actions/getHostedRunnersMachineSpecsForOrg.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Get GitHub-hosted runners machine specs for an organization
3+
example: octokit.rest.actions.getHostedRunnersMachineSpecsForOrg({ org })
4+
route: GET /orgs/{org}/actions/hosted-runners/machine-sizes
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Get GitHub-hosted runners machine specs for an organization
10+
11+
Get the list of machine specs available for GitHub-hosted runners for an organization.
12+
13+
```js
14+
octokit.rest.actions.getHostedRunnersMachineSpecsForOrg({
15+
org,
16+
});
17+
```
18+
19+
## Parameters
20+
21+
<table>
22+
<thead>
23+
<tr>
24+
<th>name</th>
25+
<th>required</th>
26+
<th>description</th>
27+
</tr>
28+
</thead>
29+
<tbody>
30+
<tr><td>org</td><td>yes</td><td>
31+
32+
The organization name. The name is not case sensitive.
33+
34+
</td></tr>
35+
</tbody>
36+
</table>
37+
38+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization).

‎docs/actions/getHostedRunnersPartnerImagesForOrg.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Get partner images for GitHub-hosted runners in an organization
3+
example: octokit.rest.actions.getHostedRunnersPartnerImagesForOrg({ org })
4+
route: GET /orgs/{org}/actions/hosted-runners/images/partner
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Get partner images for GitHub-hosted runners in an organization
10+
11+
Get the list of partner images available for GitHub-hosted runners for an organization.
12+
13+
```js
14+
octokit.rest.actions.getHostedRunnersPartnerImagesForOrg({
15+
org,
16+
});
17+
```
18+
19+
## Parameters
20+
21+
<table>
22+
<thead>
23+
<tr>
24+
<th>name</th>
25+
<th>required</th>
26+
<th>description</th>
27+
</tr>
28+
</thead>
29+
<tbody>
30+
<tr><td>org</td><td>yes</td><td>
31+
32+
The organization name. The name is not case sensitive.
33+
34+
</td></tr>
35+
</tbody>
36+
</table>
37+
38+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization).

0 commit comments

Comments
 (0)