Skip to content

Commit 61bbc9a

Browse files
authored
feat: lots of new methods and parameters (#484)
1 parent cd6e9ed commit 61bbc9a

File tree

744 files changed

+22806
-7036
lines changed

Some content is hidden

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

744 files changed

+22806
-7036
lines changed

.github/workflows/test.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,5 @@ jobs:
2929
run: npm ci
3030
- name: Test
3131
run: npm test
32+
- name: Build to verify integrity of code + types
33+
run: npm run build
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: Add custom labels to a self-hosted runner for an organization
3+
example: octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForOrg({ org, runner_id, labels })
4+
route: POST /orgs/{org}/actions/runners/{runner_id}/labels
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Add custom labels to a self-hosted runner for an organization
10+
11+
Add custom labels to a self-hosted runner configured in an organization.
12+
13+
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
14+
15+
```js
16+
octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForOrg({
17+
org,
18+
runner_id,
19+
labels,
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_id</td><td>yes</td><td>
40+
41+
Unique identifier of the self-hosted runner.
42+
43+
</td></tr>
44+
<tr><td>labels</td><td>yes</td><td>
45+
46+
The names of the custom labels to add to the runner.
47+
48+
</td></tr>
49+
</tbody>
50+
</table>
51+
52+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization).
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: Add custom labels to a self-hosted runner for a repository
3+
example: octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForRepo({ owner, repo, runner_id, labels })
4+
route: POST /repos/{owner}/{repo}/actions/runners/{runner_id}/labels
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Add custom labels to a self-hosted runner for a repository
10+
11+
Add custom labels to a self-hosted runner configured in a repository.
12+
13+
You must authenticate using an access token with the `repo` scope to use this
14+
endpoint.
15+
16+
```js
17+
octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForRepo({
18+
owner,
19+
repo,
20+
runner_id,
21+
labels,
22+
});
23+
```
24+
25+
## Parameters
26+
27+
<table>
28+
<thead>
29+
<tr>
30+
<th>name</th>
31+
<th>required</th>
32+
<th>description</th>
33+
</tr>
34+
</thead>
35+
<tbody>
36+
<tr><td>owner</td><td>yes</td><td>
37+
38+
The account owner of the repository. The name is not case sensitive.
39+
40+
</td></tr>
41+
<tr><td>repo</td><td>yes</td><td>
42+
43+
The name of the repository. The name is not case sensitive.
44+
45+
</td></tr>
46+
<tr><td>runner_id</td><td>yes</td><td>
47+
48+
Unique identifier of the self-hosted runner.
49+
50+
</td></tr>
51+
<tr><td>labels</td><td>yes</td><td>
52+
53+
The names of the custom labels to add to the runner.
54+
55+
</td></tr>
56+
</tbody>
57+
</table>
58+
59+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository).

docs/actions/addSelectedRepoToOrgSecret.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,12 @@ octokit.rest.actions.addSelectedRepoToOrgSecret({
3131
<tbody>
3232
<tr><td>org</td><td>yes</td><td>
3333

34+
The organization name. The name is not case sensitive.
35+
3436
</td></tr>
3537
<tr><td>secret_name</td><td>yes</td><td>
3638

37-
secret_name parameter
39+
The name of the secret.
3840

3941
</td></tr>
4042
<tr><td>repository_id</td><td>yes</td><td>

docs/actions/approveWorkflowRun.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,17 @@ octokit.rest.actions.approveWorkflowRun({
3333
<tbody>
3434
<tr><td>owner</td><td>yes</td><td>
3535

36+
The account owner of the repository. The name is not case sensitive.
37+
3638
</td></tr>
3739
<tr><td>repo</td><td>yes</td><td>
3840

41+
The name of the repository. The name is not case sensitive.
42+
3943
</td></tr>
4044
<tr><td>run_id</td><td>yes</td><td>
4145

42-
The id of the workflow run.
46+
The unique identifier of the workflow run.
4347

4448
</td></tr>
4549
</tbody>

docs/actions/cancelWorkflowRun.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,17 @@ octokit.rest.actions.cancelWorkflowRun({
3131
<tbody>
3232
<tr><td>owner</td><td>yes</td><td>
3333

34+
The account owner of the repository. The name is not case sensitive.
35+
3436
</td></tr>
3537
<tr><td>repo</td><td>yes</td><td>
3638

39+
The name of the repository. The name is not case sensitive.
40+
3741
</td></tr>
3842
<tr><td>run_id</td><td>yes</td><td>
3943

40-
The id of the workflow run.
44+
The unique identifier of the workflow run.
4145

4246
</td></tr>
4347
</tbody>

docs/actions/createOrUpdateEnvironmentSecret.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ console.log(encrypted);
3838

3939
#### Example encrypting a secret using Python
4040

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

4343
```
4444
from base64 import b64encode
@@ -106,6 +106,8 @@ octokit.rest.actions.createOrUpdateEnvironmentSecret({
106106
<tbody>
107107
<tr><td>repository_id</td><td>yes</td><td>
108108

109+
The unique identifier of the repository.
110+
109111
</td></tr>
110112
<tr><td>environment_name</td><td>yes</td><td>
111113

@@ -114,7 +116,7 @@ The name of the environment
114116
</td></tr>
115117
<tr><td>secret_name</td><td>yes</td><td>
116118

117-
secret_name parameter
119+
The name of the secret.
118120

119121
</td></tr>
120122
<tr><td>encrypted_value</td><td>yes</td><td>

docs/actions/createOrUpdateOrgSecret.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ console.log(encrypted);
3838

3939
#### Example encrypting a secret using Python
4040

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

4343
```
4444
from base64 import b64encode
@@ -104,10 +104,12 @@ octokit.rest.actions.createOrUpdateOrgSecret({
104104
<tbody>
105105
<tr><td>org</td><td>yes</td><td>
106106

107+
The organization name. The name is not case sensitive.
108+
107109
</td></tr>
108110
<tr><td>secret_name</td><td>yes</td><td>
109111

110-
secret_name parameter
112+
The name of the secret.
111113

112114
</td></tr>
113115
<tr><td>encrypted_value</td><td>no</td><td>
@@ -122,10 +124,7 @@ ID of the key you used to encrypt the secret.
122124
</td></tr>
123125
<tr><td>visibility</td><td>yes</td><td>
124126

125-
Configures the access that repositories have to the organization secret. Can be one of:
126-
\- `all` - All repositories in an organization can access the secret.
127-
\- `private` - Private repositories in an organization can access the secret.
128-
\- `selected` - Only specific repositories can access the secret.
127+
Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.
129128

130129
</td></tr>
131130
<tr><td>selected_repository_ids</td><td>no</td><td>

docs/actions/createOrUpdateRepoSecret.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ console.log(encrypted);
3838

3939
#### Example encrypting a secret using Python
4040

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

4343
```
4444
from base64 import b64encode
@@ -104,13 +104,17 @@ octokit.rest.actions.createOrUpdateRepoSecret({
104104
<tbody>
105105
<tr><td>owner</td><td>yes</td><td>
106106

107+
The account owner of the repository. The name is not case sensitive.
108+
107109
</td></tr>
108110
<tr><td>repo</td><td>yes</td><td>
109111

112+
The name of the repository. The name is not case sensitive.
113+
110114
</td></tr>
111115
<tr><td>secret_name</td><td>yes</td><td>
112116

113-
secret_name parameter
117+
The name of the secret.
114118

115119
</td></tr>
116120
<tr><td>encrypted_value</td><td>no</td><td>

docs/actions/createRegistrationTokenForOrg.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ octokit.rest.actions.createRegistrationTokenForOrg({
3939
<tbody>
4040
<tr><td>org</td><td>yes</td><td>
4141

42+
The organization name. The name is not case sensitive.
43+
4244
</td></tr>
4345
</tbody>
4446
</table>

0 commit comments

Comments
 (0)