Skip to content

Commit c82898a

Browse files
octokit[bot]octokit[bot]
authored
feat: add immutable releases, enterprise team membership, enterprise team organization, custom runner images, many type additions and improvements (#831)
BREAKING CHANGE: Remove listAlertsForEnterprise BREAKING CHANGE: Several custom property endpoints changed ID
1 parent 245a8e2 commit c82898a

File tree

82 files changed

+7138
-2559
lines changed

Some content is hidden

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

82 files changed

+7138
-2559
lines changed

‎docs/actions/createHostedRunnerForOrg.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,11 @@ The unique identifier of the runner image.
5656

5757
The source of the runner image.
5858

59+
</td></tr>
60+
<tr><td>image.version</td><td>no</td><td>
61+
62+
The version of the runner image to deploy. This is relevant only for runners using custom images.
63+
5964
</td></tr>
6065
<tr><td>size</td><td>yes</td><td>
6166

@@ -76,6 +81,11 @@ The maximum amount of runners to scale up to. Runners will not auto-scale above
7681

7782
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`
7883

84+
</td></tr>
85+
<tr><td>image_gen</td><td>no</td><td>
86+
87+
Whether this runner should be used to generate custom images.
88+
7989
</td></tr>
8090
</tbody>
8191
</table>

‎docs/actions/deleteCustomImageFromOrg.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Delete a custom image from the organization
3+
example: octokit.rest.actions.deleteCustomImageFromOrg({ org, image_definition_id })
4+
route: DELETE /orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Delete a custom image from the organization
10+
11+
Delete a custom image from the organization.
12+
13+
OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
14+
15+
```js
16+
octokit.rest.actions.deleteCustomImageFromOrg({
17+
org,
18+
image_definition_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>image_definition_id</td><td>yes</td><td>
39+
40+
Image definition ID of custom image
41+
42+
</td></tr>
43+
</tbody>
44+
</table>
45+
46+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization).

‎docs/actions/deleteCustomImageVersionFromOrg.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: Delete an image version of custom image from the organization
3+
example: octokit.rest.actions.deleteCustomImageVersionFromOrg({ org, image_definition_id, version })
4+
route: DELETE /orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Delete an image version of custom image from the organization
10+
11+
Delete an image version of custom image from the organization.
12+
13+
OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
14+
15+
```js
16+
octokit.rest.actions.deleteCustomImageVersionFromOrg({
17+
org,
18+
image_definition_id,
19+
version,
20+
});
21+
```
22+
23+
## Parameters
24+
25+
<table>
26+
<thead>
27+
<tr>
28+
<th>name</th>
29+
<th>required</th>
30+
<th>description</th>
31+
</tr>
32+
</thead>
33+
<tbody>
34+
<tr><td>org</td><td>yes</td><td>
35+
36+
The organization name. The name is not case sensitive.
37+
38+
</td></tr>
39+
<tr><td>image_definition_id</td><td>yes</td><td>
40+
41+
Image definition ID of custom image
42+
43+
</td></tr>
44+
<tr><td>version</td><td>yes</td><td>
45+
46+
Version of a custom image
47+
48+
</td></tr>
49+
</tbody>
50+
</table>
51+
52+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization).

‎docs/actions/getCustomImageForOrg.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Get a custom image definition for GitHub Actions Hosted Runners
3+
example: octokit.rest.actions.getCustomImageForOrg({ org, image_definition_id })
4+
route: GET /orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Get a custom image definition for GitHub Actions Hosted Runners
10+
11+
Get a custom image definition for GitHub Actions Hosted Runners.
12+
13+
OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
14+
15+
```js
16+
octokit.rest.actions.getCustomImageForOrg({
17+
org,
18+
image_definition_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>image_definition_id</td><td>yes</td><td>
39+
40+
Image definition ID of custom image
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-custom-image-definition-for-github-actions-hosted-runners).

‎docs/actions/getCustomImageVersionForOrg.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: Get an image version of a custom image for GitHub Actions Hosted Runners
3+
example: octokit.rest.actions.getCustomImageVersionForOrg({ org, image_definition_id, version })
4+
route: GET /orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Get an image version of a custom image for GitHub Actions Hosted Runners
10+
11+
Get an image version of a custom image for GitHub Actions Hosted Runners.
12+
13+
OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
14+
15+
```js
16+
octokit.rest.actions.getCustomImageVersionForOrg({
17+
org,
18+
image_definition_id,
19+
version,
20+
});
21+
```
22+
23+
## Parameters
24+
25+
<table>
26+
<thead>
27+
<tr>
28+
<th>name</th>
29+
<th>required</th>
30+
<th>description</th>
31+
</tr>
32+
</thead>
33+
<tbody>
34+
<tr><td>org</td><td>yes</td><td>
35+
36+
The organization name. The name is not case sensitive.
37+
38+
</td></tr>
39+
<tr><td>image_definition_id</td><td>yes</td><td>
40+
41+
Image definition ID of custom image
42+
43+
</td></tr>
44+
<tr><td>version</td><td>yes</td><td>
45+
46+
Version of a custom image
47+
48+
</td></tr>
49+
</tbody>
50+
</table>
51+
52+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners).

‎docs/actions/listCustomImageVersionsForOrg.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: List image versions of a custom image for an organization
3+
example: octokit.rest.actions.listCustomImageVersionsForOrg({ image_definition_id, org })
4+
route: GET /orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# List image versions of a custom image for an organization
10+
11+
List image versions of a custom image for an organization.
12+
13+
OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
14+
15+
```js
16+
octokit.rest.actions.listCustomImageVersionsForOrg({
17+
image_definition_id,
18+
org,
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>image_definition_id</td><td>yes</td><td>
34+
35+
Image definition ID of custom image
36+
37+
</td></tr>
38+
<tr><td>org</td><td>yes</td><td>
39+
40+
The organization name. The name is not case sensitive.
41+
42+
</td></tr>
43+
</tbody>
44+
</table>
45+
46+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization).

‎docs/actions/listCustomImagesForOrg.md‎

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

‎docs/actions/updateHostedRunnerForOrg.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,11 @@ The maximum amount of runners to scale up to. Runners will not auto-scale above
5858

5959
Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`
6060

61+
</td></tr>
62+
<tr><td>image_version</td><td>no</td><td>
63+
64+
The version of the runner image to deploy. This is relevant only for runners using custom images.
65+
6166
</td></tr>
6267
</tbody>
6368
</table>

‎docs/apps/createInstallationAccessToken.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,11 @@ The level of permission to grant the access token to manage Dependabot alerts.
167167

168168
The level of permission to grant the access token to update GitHub Actions workflow files.
169169

170+
</td></tr>
171+
<tr><td>permissions.custom_properties_for_organizations</td><td>no</td><td>
172+
173+
The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.
174+
170175
</td></tr>
171176
<tr><td>permissions.members</td><td>no</td><td>
172177

@@ -190,7 +195,7 @@ The level of permission to grant the access token for custom organization roles
190195
</td></tr>
191196
<tr><td>permissions.organization_custom_properties</td><td>no</td><td>
192197

193-
The level of permission to grant the access token for custom property management.
198+
The level of permission to grant the access token for repository custom properties management at the organization level.
194199

195200
</td></tr>
196201
<tr><td>permissions.organization_copilot_seat_management</td><td>no</td><td>
@@ -292,6 +297,11 @@ The level of permission to grant the access token to manage the profile settings
292297

293298
The level of permission to grant the access token to list and manage repositories a user is starring.
294299

300+
</td></tr>
301+
<tr><td>permissions.enterprise_custom_properties_for_organizations</td><td>no</td><td>
302+
303+
The level of permission to grant the access token for organization custom properties management at the enterprise level.
304+
295305
</td></tr>
296306
</tbody>
297307
</table>

‎docs/apps/scopeToken.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,11 @@ The level of permission to grant the access token to manage Dependabot alerts.
181181

182182
The level of permission to grant the access token to update GitHub Actions workflow files.
183183

184+
</td></tr>
185+
<tr><td>permissions.custom_properties_for_organizations</td><td>no</td><td>
186+
187+
The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.
188+
184189
</td></tr>
185190
<tr><td>permissions.members</td><td>no</td><td>
186191

@@ -204,7 +209,7 @@ The level of permission to grant the access token for custom organization roles
204209
</td></tr>
205210
<tr><td>permissions.organization_custom_properties</td><td>no</td><td>
206211

207-
The level of permission to grant the access token for custom property management.
212+
The level of permission to grant the access token for repository custom properties management at the organization level.
208213

209214
</td></tr>
210215
<tr><td>permissions.organization_copilot_seat_management</td><td>no</td><td>
@@ -306,6 +311,11 @@ The level of permission to grant the access token to manage the profile settings
306311

307312
The level of permission to grant the access token to list and manage repositories a user is starring.
308313

314+
</td></tr>
315+
<tr><td>permissions.enterprise_custom_properties_for_organizations</td><td>no</td><td>
316+
317+
The level of permission to grant the access token for organization custom properties management at the enterprise level.
318+
309319
</td></tr>
310320
</tbody>
311321
</table>

0 commit comments

Comments
 (0)