Skip to content

Commit 5e1ecd4

Browse files
authored
feat: new action runner groups endpoints, new code scanning alerts autofix endpoints, new sub-issues endpoints, new private registries enpoints, new code security endpoints, various description updates (#777)
- Description updates - New `/enterprises/{enterprise}/copilot/billing/seats` - New `/enterprises/{enterprise}/settings/billing/cost-centers` - New `/enterprises/{enterprise}/settings/billing/usage` - New `/enterprises/{enterprise}/code-security/configurations/defaults` - New `/enterprises/{enterprise}/code-security/configurations/{configuration_id}` - New `/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach` - New `/orgs/{org}/actions/runner-groups` - New `/orgs/{org}/actions/runner-groups/{runner_group_id}` - New `/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories` - New `/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}` - New `/orgs/{org}/actions/runner-groups/{runner_group_id}/runners` - New `/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}` - New `/orgs/{org}/copilot/metrics` - New `/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}` - New `/orgs/{org}/insights/api/subject-stats` - New `/orgs/{org}/insights/api/summary-stats` - New `/orgs/{org}/insights/api/summary-stats/users/{user_id}` - New `/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}` - New `/orgs/{org}/insights/api/time-stats` - New `/orgs/{org}/insights/api/time-stats/users/{user_id}` - New `/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}` - New `/orgs/{org}/insights/api/user-stats/{user_id}` - New `/orgs/{org}/private-registries` - New `/orgs/{org}/private-registries/public-key` - New `/orgs/{org}/private-registries/{secret_name}` - New `/orgs/{org}/team/{team_slug}/copilot/metrics` - New `/orgs/{org}/team/{team_slug}/copilot/usage` - **Deprecate `/orgs/{org}/{security_product}/{enablement}`** - New `/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix` - New `/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits` - New `/repos/{owner}/{repo}/code-security-configuration` - Add discriminators for various properties - New `/repos/{owner}/{repo}/issues/{issue_number}/sub_issues` - New `/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority` - New `/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses` - New `/repos/{owner}/{repo}/secret-scanning/scan-history`
1 parent 577d7d7 commit 5e1ecd4

File tree

298 files changed

+13347
-3379
lines changed

Some content is hidden

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

298 files changed

+13347
-3379
lines changed
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: Add repository access to a self-hosted runner group in an organization
3+
example: octokit.rest.actions.addRepoAccessToSelfHostedRunnerGroupInOrg({ org, runner_group_id, repository_id })
4+
route: PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Add repository access to a self-hosted runner group in an organization
10+
11+
Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)."
12+
13+
OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
14+
15+
```js
16+
octokit.rest.actions.addRepoAccessToSelfHostedRunnerGroupInOrg({
17+
org,
18+
runner_group_id,
19+
repository_id,
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>runner_group_id</td><td>yes</td><td>
40+
41+
Unique identifier of the self-hosted runner group.
42+
43+
</td></tr>
44+
<tr><td>repository_id</td><td>yes</td><td>
45+
46+
The unique identifier of the repository.
47+
48+
</td></tr>
49+
</tbody>
50+
</table>
51+
52+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization).

docs/actions/listWorkflowRuns.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Anyone with read access to the repository can use this endpoint
1414

1515
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
1616

17+
This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.
18+
1719
```js
1820
octokit.rest.actions.listWorkflowRuns({
1921
owner,

docs/actions/listWorkflowRunsForRepo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Anyone with read access to the repository can use this endpoint.
1414

1515
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
1616

17-
This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.
17+
This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.
1818

1919
```js
2020
octokit.rest.actions.listWorkflowRunsForRepo({

docs/actions/reviewCustomGatesForRun.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ type: API method
1010

1111
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
1212

13-
**Note:** GitHub Apps can only review their own custom deployment protection rules.
14-
To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).
13+
> [!NOTE]
14+
> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).
1515
1616
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
1717

docs/actions/setAllowedActionsOrganization.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ Whether actions from GitHub Marketplace verified creators are allowed. Set to `t
4848

4949
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.
5050

51-
**Note**: The `patterns_allowed` setting only applies to public repositories.
51+
> [!NOTE]
52+
> The `patterns_allowed` setting only applies to public repositories.
5253
5354
</td></tr>
5455
</tbody>

docs/actions/setAllowedActionsRepository.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ Whether actions from GitHub Marketplace verified creators are allowed. Set to `t
5454

5555
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.
5656

57-
**Note**: The `patterns_allowed` setting only applies to public repositories.
57+
> [!NOTE]
58+
> The `patterns_allowed` setting only applies to public repositories.
5859
5960
</td></tr>
6061
</tbody>

docs/activity/getFeeds.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ Lists the feeds available to the authenticated user. The response provides a URL
2020

2121
By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
2222

23-
**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.
23+
> [!NOTE]
24+
> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.
2425
2526
```js
2627
octokit.rest.activity.getFeeds();

docs/activity/listEventsForAuthenticatedUser.md

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

99
# List events for the authenticated user
1010

11-
If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.
11+
If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read).
12+
13+
> [!NOTE]
14+
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
1215
1316
```js
1417
octokit.rest.activity.listEventsForAuthenticatedUser({

docs/activity/listOrgEventsForAuthenticatedUser.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ type: API method
1010

1111
This is the user's organization dashboard. You must be authenticated as the user to view this.
1212

13+
> [!NOTE]
14+
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
15+
1316
```js
1417
octokit.rest.activity.listOrgEventsForAuthenticatedUser({
1518
username,

docs/activity/listPublicEvents.md

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

99
# List public events
1010

11-
We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.
11+
> [!NOTE]
12+
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
1213
1314
```js
1415
octokit.rest.activity.listPublicEvents();

0 commit comments

Comments
 (0)