Skip to content

Commit 60f1dea

Browse files
gr2mgr2m
committed
docs: separate markdown files for all endpoint methods
1 parent 8129ff9 commit 60f1dea

File tree

631 files changed

+28212
-0
lines changed

Some content is hidden

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

631 files changed

+28212
-0
lines changed

‎docs/actions/cancelWorkflowRun.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Cancel a workflow run
2+
3+
Cancels a workflow run using its `id`. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
4+
5+
```js
6+
octokit.actions.cancelWorkflowRun(owner, repo, run_id);
7+
```
8+
9+
## Parameters
10+
11+
<table>
12+
<thead>
13+
<tr>
14+
<th>name</th>
15+
<th>required</th>
16+
<th>description</th>
17+
</tr>
18+
</thead>
19+
<tbody>
20+
<tr><td>owner</td><td>yes</td><td>
21+
22+
owner parameter
23+
24+
</td></tr>
25+
<tr><td>repo</td><td>yes</td><td>
26+
27+
repo parameter
28+
29+
</td></tr>
30+
<tr><td>run_id</td><td>yes</td><td>
31+
32+
run_id parameter
33+
34+
</td></tr>
35+
</tbody>
36+
</table>
37+
38+
See also: [GitHub Developer Guide documentation](endpoint.documentationUrl).

‎docs/actions/createOrUpdateSecretForRepo.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Create or update a secret for a repository
2+
3+
Creates or updates a secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.
4+
5+
Encrypt your secret using the [tweetsodium](https://github.com/mastahyeti/tweetsodium) library.
6+
7+
Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.
8+
9+
Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
10+
11+
Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
12+
13+
```js
14+
octokit.actions.createOrUpdateSecretForRepo(owner, repo, name);
15+
```
16+
17+
## Parameters
18+
19+
<table>
20+
<thead>
21+
<tr>
22+
<th>name</th>
23+
<th>required</th>
24+
<th>description</th>
25+
</tr>
26+
</thead>
27+
<tbody>
28+
<tr><td>owner</td><td>yes</td><td>
29+
30+
owner parameter
31+
32+
</td></tr>
33+
<tr><td>repo</td><td>yes</td><td>
34+
35+
repo parameter
36+
37+
</td></tr>
38+
<tr><td>name</td><td>yes</td><td>
39+
40+
name parameter
41+
42+
</td></tr>
43+
<tr><td>encrypted_value</td><td>no</td><td>
44+
45+
Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get your public key](https://developer.github.com/v3/actions/secrets/#get-your-public-key) endpoint.
46+
47+
</td></tr>
48+
<tr><td>key_id</td><td>no</td><td>
49+
50+
ID of the key you used to encrypt the secret.
51+
52+
</td></tr>
53+
</tbody>
54+
</table>
55+
56+
See also: [GitHub Developer Guide documentation](endpoint.documentationUrl).

‎docs/actions/createRegistrationToken.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Create a registration token
2+
3+
Returns a token that you can pass to the `config` script. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.
4+
5+
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
6+
7+
```js
8+
octokit.actions.createRegistrationToken(owner, repo);
9+
```
10+
11+
## Parameters
12+
13+
<table>
14+
<thead>
15+
<tr>
16+
<th>name</th>
17+
<th>required</th>
18+
<th>description</th>
19+
</tr>
20+
</thead>
21+
<tbody>
22+
<tr><td>owner</td><td>yes</td><td>
23+
24+
owner parameter
25+
26+
</td></tr>
27+
<tr><td>repo</td><td>yes</td><td>
28+
29+
repo parameter
30+
31+
</td></tr>
32+
</tbody>
33+
</table>
34+
35+
See also: [GitHub Developer Guide documentation](endpoint.documentationUrl).

‎docs/actions/createRemoveToken.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Create a remove token
2+
3+
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.
4+
5+
Remove your self-hosted runner from a repository, replacing TOKEN with the remove token provided by this endpoint.
6+
7+
```js
8+
octokit.actions.createRemoveToken(owner, repo);
9+
```
10+
11+
## Parameters
12+
13+
<table>
14+
<thead>
15+
<tr>
16+
<th>name</th>
17+
<th>required</th>
18+
<th>description</th>
19+
</tr>
20+
</thead>
21+
<tbody>
22+
<tr><td>owner</td><td>yes</td><td>
23+
24+
owner parameter
25+
26+
</td></tr>
27+
<tr><td>repo</td><td>yes</td><td>
28+
29+
repo parameter
30+
31+
</td></tr>
32+
</tbody>
33+
</table>
34+
35+
See also: [GitHub Developer Guide documentation](endpoint.documentationUrl).

‎docs/actions/deleteArtifact.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Delete an artifact
2+
3+
Deletes an artifact for a workflow run. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
4+
5+
```js
6+
octokit.actions.deleteArtifact(owner, repo, artifact_id);
7+
```
8+
9+
## Parameters
10+
11+
<table>
12+
<thead>
13+
<tr>
14+
<th>name</th>
15+
<th>required</th>
16+
<th>description</th>
17+
</tr>
18+
</thead>
19+
<tbody>
20+
<tr><td>owner</td><td>yes</td><td>
21+
22+
owner parameter
23+
24+
</td></tr>
25+
<tr><td>repo</td><td>yes</td><td>
26+
27+
repo parameter
28+
29+
</td></tr>
30+
<tr><td>artifact_id</td><td>yes</td><td>
31+
32+
artifact_id parameter
33+
34+
</td></tr>
35+
</tbody>
36+
</table>
37+
38+
See also: [GitHub Developer Guide documentation](endpoint.documentationUrl).

‎docs/actions/deleteSecretFromRepo.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Delete a secret from a repository
2+
3+
Deletes a secret in a repository using the secret name. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.
4+
5+
```js
6+
octokit.actions.deleteSecretFromRepo(owner, repo, name);
7+
```
8+
9+
## Parameters
10+
11+
<table>
12+
<thead>
13+
<tr>
14+
<th>name</th>
15+
<th>required</th>
16+
<th>description</th>
17+
</tr>
18+
</thead>
19+
<tbody>
20+
<tr><td>owner</td><td>yes</td><td>
21+
22+
owner parameter
23+
24+
</td></tr>
25+
<tr><td>repo</td><td>yes</td><td>
26+
27+
repo parameter
28+
29+
</td></tr>
30+
<tr><td>name</td><td>yes</td><td>
31+
32+
name parameter
33+
34+
</td></tr>
35+
</tbody>
36+
</table>
37+
38+
See also: [GitHub Developer Guide documentation](endpoint.documentationUrl).

‎docs/actions/downloadArtifact.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Download an artifact
2+
3+
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
4+
5+
Call this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag.
6+
7+
```js
8+
octokit.actions.downloadArtifact(owner, repo, artifact_id, archive_format);
9+
```
10+
11+
## Parameters
12+
13+
<table>
14+
<thead>
15+
<tr>
16+
<th>name</th>
17+
<th>required</th>
18+
<th>description</th>
19+
</tr>
20+
</thead>
21+
<tbody>
22+
<tr><td>owner</td><td>yes</td><td>
23+
24+
owner parameter
25+
26+
</td></tr>
27+
<tr><td>repo</td><td>yes</td><td>
28+
29+
repo parameter
30+
31+
</td></tr>
32+
<tr><td>artifact_id</td><td>yes</td><td>
33+
34+
artifact_id parameter
35+
36+
</td></tr>
37+
<tr><td>archive_format</td><td>yes</td><td>
38+
39+
archive_format parameter
40+
41+
</td></tr>
42+
</tbody>
43+
</table>
44+
45+
See also: [GitHub Developer Guide documentation](endpoint.documentationUrl).

‎docs/actions/getArtifact.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Get an artifact
2+
3+
Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
4+
5+
```js
6+
octokit.actions.getArtifact(owner, repo, artifact_id);
7+
```
8+
9+
## Parameters
10+
11+
<table>
12+
<thead>
13+
<tr>
14+
<th>name</th>
15+
<th>required</th>
16+
<th>description</th>
17+
</tr>
18+
</thead>
19+
<tbody>
20+
<tr><td>owner</td><td>yes</td><td>
21+
22+
owner parameter
23+
24+
</td></tr>
25+
<tr><td>repo</td><td>yes</td><td>
26+
27+
repo parameter
28+
29+
</td></tr>
30+
<tr><td>artifact_id</td><td>yes</td><td>
31+
32+
artifact_id parameter
33+
34+
</td></tr>
35+
</tbody>
36+
</table>
37+
38+
See also: [GitHub Developer Guide documentation](endpoint.documentationUrl).

‎docs/actions/getPublicKey.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Get your public key
2+
3+
Gets your public key, which you must store. You need your public key to use other secrets endpoints. Use the returned `key` to encrypt your secrets. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.
4+
5+
```js
6+
octokit.actions.getPublicKey(owner, repo);
7+
```
8+
9+
## Parameters
10+
11+
<table>
12+
<thead>
13+
<tr>
14+
<th>name</th>
15+
<th>required</th>
16+
<th>description</th>
17+
</tr>
18+
</thead>
19+
<tbody>
20+
<tr><td>owner</td><td>yes</td><td>
21+
22+
owner parameter
23+
24+
</td></tr>
25+
<tr><td>repo</td><td>yes</td><td>
26+
27+
repo parameter
28+
29+
</td></tr>
30+
</tbody>
31+
</table>
32+
33+
See also: [GitHub Developer Guide documentation](endpoint.documentationUrl).

0 commit comments

Comments
 (0)