Skip to content

Commit 34559d8

Browse files
octokitbotoctokitbot
authoredSep 3, 2020
fix: machine-man preview graduated (#185)
·
v13.5.0v4.1.4
1 parent 44891b0 commit 34559d8

18 files changed

+326
-297
lines changed
 

‎docs/actions/createRegistrationTokenForOrg.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@ type: API method
88

99
# Create a registration token for an organization
1010

11-
**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
11+
Returns a token that you can pass to the `config` script. The token expires after one hour.
1212

13-
Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate
14-
using an access token with the `admin:org` scope to use this endpoint.
13+
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
1514

1615
#### Example using registration token
1716

‎docs/actions/createRemoveTokenForOrg.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,9 @@ type: API method
88

99
# Create a remove token for an organization
1010

11-
**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
11+
Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.
1212

13-
Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The
14-
token expires after one hour. You must authenticate using an access token with the `admin:org` scope to use this
15-
endpoint.
13+
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
1614

1715
#### Example using remove token
1816

‎docs/actions/deleteSelfHostedRunnerFromOrg.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ type: API method
88

99
# Delete a self-hosted runner from an organization
1010

11-
**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
11+
Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
1212

13-
Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. You must authenticate using an access token with the `admin:org` scope to use this endpoint.
13+
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
1414

1515
```js
1616
octokit.actions.deleteSelfHostedRunnerFromOrg({
@@ -35,6 +35,8 @@ octokit.actions.deleteSelfHostedRunnerFromOrg({
3535
</td></tr>
3636
<tr><td>runner_id</td><td>yes</td><td>
3737

38+
Unique identifier of the self-hosted runner.
39+
3840
</td></tr>
3941
</tbody>
4042
</table>

‎docs/actions/deleteSelfHostedRunnerFromRepo.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ type: API method
88

99
# Delete a self-hosted runner from a repository
1010

11-
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. You must authenticate using an access token with the `repo` scope to use this endpoint.
11+
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
12+
13+
You must authenticate using an access token with the `repo`
14+
scope to use this endpoint.
1215

1316
```js
1417
octokit.actions.deleteSelfHostedRunnerFromRepo({
@@ -37,6 +40,8 @@ octokit.actions.deleteSelfHostedRunnerFromRepo({
3740
</td></tr>
3841
<tr><td>runner_id</td><td>yes</td><td>
3942

43+
Unique identifier of the self-hosted runner.
44+
4045
</td></tr>
4146
</tbody>
4247
</table>

‎docs/actions/getSelfHostedRunnerForOrg.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ type: API method
88

99
# Get a self-hosted runner for an organization
1010

11-
**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
11+
Gets a specific self-hosted runner configured in an organization.
1212

13-
Gets a specific self-hosted runner for an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint.
13+
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
1414

1515
```js
1616
octokit.actions.getSelfHostedRunnerForOrg({
@@ -35,6 +35,8 @@ octokit.actions.getSelfHostedRunnerForOrg({
3535
</td></tr>
3636
<tr><td>runner_id</td><td>yes</td><td>
3737

38+
Unique identifier of the self-hosted runner.
39+
3840
</td></tr>
3941
</tbody>
4042
</table>

‎docs/actions/getSelfHostedRunnerForRepo.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ type: API method
88

99
# Get a self-hosted runner for a repository
1010

11-
Gets a specific self-hosted runner. You must authenticate using an access token with the `repo` scope to use this endpoint.
11+
Gets a specific 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.
1215

1316
```js
1417
octokit.actions.getSelfHostedRunnerForRepo({
@@ -37,6 +40,8 @@ octokit.actions.getSelfHostedRunnerForRepo({
3740
</td></tr>
3841
<tr><td>runner_id</td><td>yes</td><td>
3942

43+
Unique identifier of the self-hosted runner.
44+
4045
</td></tr>
4146
</tbody>
4247
</table>

‎docs/actions/listRunnerApplicationsForOrg.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ type: API method
88

99
# List runner applications for an organization
1010

11-
**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
11+
Lists binaries for the runner application that you can download and run.
1212

13-
Lists binaries for the runner application that you can download and run. You must authenticate using an access token with the `admin:org` scope to use this endpoint.
13+
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
1414

1515
```js
1616
octokit.actions.listRunnerApplicationsForOrg({

‎docs/actions/listRunnerApplicationsForRepo.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ type: API method
88

99
# List runner applications for a repository
1010

11-
Lists binaries for the runner application that you can download and run. You must authenticate using an access token with the `repo` scope to use this endpoint.
11+
Lists binaries for the runner application that you can download and run.
12+
13+
You must authenticate using an access token with the `repo` scope to use this endpoint.
1214

1315
```js
1416
octokit.actions.listRunnerApplicationsForRepo({

‎docs/actions/listSelfHostedRunnersForOrg.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ type: API method
88

99
# List self-hosted runners for an organization
1010

11-
**Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
11+
Lists all self-hosted runners configured in an organization.
1212

13-
Lists all self-hosted runners for an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint.
13+
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
1414

1515
```js
1616
octokit.actions.listSelfHostedRunnersForOrg({

‎docs/actions/listSelfHostedRunnersForRepo.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ type: API method
88

99
# List self-hosted runners for a repository
1010

11-
Lists all self-hosted runners for a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.
11+
Lists all self-hosted runners configured in a repository.
12+
You must authenticate using an access token with the `repo` scope to use this endpoint.
1213

1314
```js
1415
octokit.actions.listSelfHostedRunnersForRepo({

‎docs/repos/createPagesSite.md

+14-8
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
---
22
name: Create a GitHub Pages site
3-
example: octokit.repos.createPagesSite({ owner, repo })
3+
example: octokit.repos.createPagesSite({ owner, repo, source, source.branch })
44
route: POST /repos/{owner}/{repo}/pages
55
scope: repos
66
type: API method
77
---
88

99
# Create a GitHub Pages site
1010

11+
Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."
12+
1113
```js
1214
octokit.repos.createPagesSite({
13-
owner,
14-
repo,
15-
});
15+
owner,
16+
repo,
17+
source,
18+
source.branch
19+
})
1620
```
1721

1822
## Parameters
@@ -32,17 +36,19 @@ octokit.repos.createPagesSite({
3236
<tr><td>repo</td><td>yes</td><td>
3337

3438
</td></tr>
35-
<tr><td>source</td><td>no</td><td>
39+
<tr><td>source</td><td>yes</td><td>
40+
41+
The source branch and directory used to publish your Pages site.
3642

3743
</td></tr>
38-
<tr><td>source.branch</td><td>no</td><td>
44+
<tr><td>source.branch</td><td>yes</td><td>
3945

40-
The repository branch used to publish your [site's source files](https://docs.github.com/articles/configuring-a-publishing-source-for-github-pages/). Can be either `master` or `gh-pages`.
46+
The repository branch used to publish your site's source files.
4147

4248
</td></tr>
4349
<tr><td>source.path</td><td>no</td><td>
4450

45-
The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.
51+
The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`
4652

4753
</td></tr>
4854
</tbody>

‎docs/repos/getCommit.md

+58-19
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,72 @@ type: API method
88

99
# Get a commit
1010

11-
Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.
11+
Returns the contents of a single commit reference. You must have `read` access for the repository to use this
12+
endpoint.
1213

13-
You can pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.
14+
**Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
1415

15-
To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
16+
You can pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to
17+
fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.
18+
19+
To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media
20+
type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use
21+
this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by
22+
providing the local SHA-1 reference as the ETag.
1623

1724
**Signature verification object**
1825

19-
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
26+
The response will include a `verification` object that describes the result of verifying the commit's signature. The
27+
following fields are included in the `verification` object:
2028

2129
These are the possible values for `reason` in the `verification` object:
2230

23-
| Value | Description |
24-
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
25-
| `expired_key` | The key that made the signature is expired. |
26-
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
27-
| `gpgverify_error` | There was an error communicating with the signature verification service. |
28-
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
29-
| `unsigned` | The object does not include a signature. |
30-
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
31-
| `no_user` | No user was associated with the `committer` email address in the commit. |
32-
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
33-
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
34-
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
35-
| `malformed_signature` | There was an error parsing the signature. |
36-
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
37-
| `valid` | None of the above errors applied, so the signature is considered to be verified. |
31+
| Value |
32+
Description
33+
|
34+
35+
## | ------------------------ |
36+
37+
|
38+
39+
| `expired_key` | The key that made the signature is
40+
expired. |
41+
42+
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the
43+
signature. |
44+
45+
| `gpgverify_error` | There was an error communicating with the signature verification
46+
service. |
47+
48+
| `gpgverify_unavailable` | The signature verification service is currently
49+
unavailable. |
50+
51+
| `unsigned` | The object does not include a
52+
signature. |
53+
54+
| `unknown_signature_type` | A non-PGP signature was found in the
55+
commit. |
56+
57+
| `no_user` | No user was associated with the `committer` email address in the
58+
commit. |
59+
60+
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email
61+
address is not verified on her/his account. |
62+
63+
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP
64+
key that made the signature. |
65+
66+
| `unknown_key` | The key that made the signature has not been registered with any user's
67+
account. |
68+
69+
| `malformed_signature` | There was an error parsing the
70+
signature. |
71+
72+
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was
73+
found in the signature. |
74+
75+
| `valid` | None of the above errors applied, so the signature is considered to be
76+
verified. |
3877

3978
```js
4079
octokit.repos.getCommit({

‎docs/repos/updateInformationAboutPagesSite.md

+21-6
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
---
22
name: Update information about a GitHub Pages site
3-
example: octokit.repos.updateInformationAboutPagesSite({ owner, repo })
3+
example: octokit.repos.updateInformationAboutPagesSite({ owner, repo, source, source.branch, source.path })
44
route: PUT /repos/{owner}/{repo}/pages
55
scope: repos
66
type: API method
77
---
88

99
# Update information about a GitHub Pages site
1010

11+
Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
12+
1113
```js
1214
octokit.repos.updateInformationAboutPagesSite({
13-
owner,
14-
repo,
15-
});
15+
owner,
16+
repo,
17+
source,
18+
source.branch,
19+
source.path
20+
})
1621
```
1722

1823
## Parameters
@@ -37,9 +42,19 @@ octokit.repos.updateInformationAboutPagesSite({
3742
Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)."
3843

3944
</td></tr>
40-
<tr><td>source</td><td>no</td><td>
45+
<tr><td>source</td><td>yes</td><td>
46+
47+
Update the source for the repository. Must include the branch name and path.
48+
49+
</td></tr>
50+
<tr><td>source.branch</td><td>yes</td><td>
51+
52+
The repository branch used to publish your site's source files.
53+
54+
</td></tr>
55+
<tr><td>source.path</td><td>yes</td><td>
4156

42-
Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `"gh-pages"`, `"master"`, and `"master /docs"`.
57+
The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.
4358

4459
</td></tr>
4560
</tbody>

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"author": "Gregor Martynus (https://twitter.com/gr2m)",
2525
"license": "MIT",
2626
"dependencies": {
27-
"@octokit/types": "^5.1.1",
27+
"@octokit/types": "^5.4.1",
2828
"deprecation": "^2.3.1"
2929
},
3030
"devDependencies": {

0 commit comments

Comments
 (0)
Please sign in to comment.