Skip to content

Commit 5807be8

Browse files
fix: recover deprecated octokit.actions.deleteSecretFromRepo() method, send correct request for octokit.actions.createOrUpdateSecretForRepo() (#86)
Co-authored-by: Octokit Bot <33075676+octokitbot@users.noreply.github.com>
1 parent d245c54 commit 5807be8

File tree

6 files changed

+123
-13
lines changed

6 files changed

+123
-13
lines changed

docs/actions/createOrUpdateSecretForRepo.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,24 @@
11
---
2-
name: Delete a repository secret
2+
name: Create or update a repository secret
33
example: octokit.actions.createOrUpdateSecretForRepo({ owner, repo, secret_name })
4-
route: DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}
4+
route: PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}
55
scope: actions
66
type: API method
77
---
88

9-
# Delete a repository secret
9+
# Create or update a repository secret
1010

1111
**Deprecated:** This method has been renamed to actions.createOrUpdateRepoSecret
1212

13-
Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
13+
Creates or updates a repository secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
14+
15+
Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
16+
17+
Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.
18+
19+
Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
20+
21+
Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
1422

1523
```js
1624
octokit.actions.createOrUpdateSecretForRepo({
@@ -39,11 +47,21 @@ octokit.actions.createOrUpdateSecretForRepo({
3947
</td></tr>
4048
<tr><td>secret_name</td><td>yes</td><td>
4149

50+
</td></tr>
51+
<tr><td>encrypted_value</td><td>no</td><td>
52+
53+
Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://developer.github.com/v3/actions/secrets/#get-a-repository-public-key) endpoint.
54+
55+
</td></tr>
56+
<tr><td>key_id</td><td>no</td><td>
57+
58+
ID of the key you used to encrypt the secret.
59+
4260
</td></tr>
4361
<tr><td>name</td><td>no</td><td>
4462

4563
</td></tr>
4664
</tbody>
4765
</table>
4866

49-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/secrets/#delete-a-repository-secret).
67+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/secrets/#create-or-update-a-repository-secret).
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: Delete a repository secret
3+
example: octokit.actions.deleteSecretFromRepo({ owner, repo, secret_name })
4+
route: DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Delete a repository secret
10+
11+
**Deprecated:** This method has been renamed to actions.deleteRepoSecret
12+
13+
Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
14+
15+
```js
16+
octokit.actions.deleteSecretFromRepo({
17+
owner,
18+
repo,
19+
secret_name,
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>owner</td><td>yes</td><td>
35+
36+
</td></tr>
37+
<tr><td>repo</td><td>yes</td><td>
38+
39+
</td></tr>
40+
<tr><td>secret_name</td><td>yes</td><td>
41+
42+
</td></tr>
43+
<tr><td>name</td><td>no</td><td>
44+
45+
</td></tr>
46+
</tbody>
47+
</table>
48+
49+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/secrets/#delete-a-repository-secret).

scripts/update-endpoints/generated/endpoints.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15888,7 +15888,7 @@
1588815888
{
1588915889
"name": "Delete a repository secret",
1589015890
"scope": "actions",
15891-
"id": "createOrUpdateSecretForRepo",
15891+
"id": "deleteSecretFromRepo",
1589215892
"method": "DELETE",
1589315893
"url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}",
1589415894
"isDeprecated": false,
@@ -15953,10 +15953,10 @@
1595315953
],
1595415954
"responses": [],
1595515955
"renamed": {
15956-
"before": { "scope": "actions", "id": "createOrUpdateSecretForRepo" },
15957-
"after": { "scope": "actions", "id": "createOrUpdateRepoSecret" },
15956+
"before": { "scope": "actions", "id": "deleteSecretFromRepo" },
15957+
"after": { "scope": "actions", "id": "deleteRepoSecret" },
1595815958
"date": "2020-05-14",
15959-
"note": "\"actions/create-or-update-secret-for-repo\" operation ID is now \"actions/create-or-update-repo-secret\""
15959+
"note": "\"actions/delete-secret-from-repo\" operation ID is now \"actions/delete-repo-secret\""
1596015960
}
1596115961
},
1596215962
{

src/generated/endpoints.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
1414
{ renamedParameters: { name: "secret_name" } },
1515
],
1616
createOrUpdateSecretForRepo: [
17-
"DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}",
17+
"PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}",
1818
{},
1919
{
2020
renamed: ["actions", "createOrUpdateRepoSecret"],
@@ -50,6 +50,14 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
5050
{},
5151
{ renamedParameters: { name: "secret_name" } },
5252
],
53+
deleteSecretFromRepo: [
54+
"DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}",
55+
{},
56+
{
57+
renamed: ["actions", "deleteRepoSecret"],
58+
renamedParameters: { name: "secret_name" },
59+
},
60+
],
5361
deleteSelfHostedRunnerFromOrg: [
5462
"DELETE /orgs/{org}/actions/runners/{runner_id}",
5563
],

src/generated/method-types.ts

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,21 @@ export type RestEndpointMethods = {
8080
endpoint: EndpointInterface<{ url: string }>;
8181
};
8282
/**
83-
* Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
83+
* Creates or updates a repository secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
84+
*
85+
* Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
86+
*
87+
*
88+
*
89+
* Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.
90+
*
91+
*
92+
*
93+
* Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
94+
*
95+
*
96+
*
97+
* Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
8498
* @deprecated octokit.actions.createOrUpdateSecretForRepo() has been renamed to octokit.actions.createOrUpdateRepoSecret() (2020-05-14)
8599
*/
86100
createOrUpdateSecretForRepo: {
@@ -218,6 +232,19 @@ export type RestEndpointMethods = {
218232
defaults: RequestInterface["defaults"];
219233
endpoint: EndpointInterface<{ url: string }>;
220234
};
235+
/**
236+
* Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
237+
* @deprecated octokit.actions.deleteSecretFromRepo() has been renamed to octokit.actions.deleteRepoSecret() (2020-05-14)
238+
*/
239+
deleteSecretFromRepo: {
240+
(
241+
params?: RestEndpointMethodTypes["actions"]["deleteSecretFromRepo"]["parameters"]
242+
): Promise<
243+
RestEndpointMethodTypes["actions"]["deleteSecretFromRepo"]["response"]
244+
>;
245+
defaults: RequestInterface["defaults"];
246+
endpoint: EndpointInterface<{ url: string }>;
247+
};
221248
/**
222249
* **Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change.
223250
*

src/generated/parameters-and-response-types.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ export type RestEndpointMethodTypes = {
3737
createOrUpdateSecretForRepo: {
3838
parameters: RequestParameters &
3939
Omit<
40-
Endpoints["DELETE /repos/:owner/:repo/actions/secrets/:secret_name"]["parameters"],
40+
Endpoints["PUT /repos/:owner/:repo/actions/secrets/:secret_name"]["parameters"],
4141
"baseUrl" | "headers" | "mediaType"
4242
>;
43-
response: Endpoints["DELETE /repos/:owner/:repo/actions/secrets/:secret_name"]["response"];
43+
response: Endpoints["PUT /repos/:owner/:repo/actions/secrets/:secret_name"]["response"];
4444
};
4545
createRegistrationToken: {
4646
parameters: RequestParameters &
@@ -114,6 +114,14 @@ export type RestEndpointMethodTypes = {
114114
>;
115115
response: Endpoints["DELETE /repos/:owner/:repo/actions/secrets/:secret_name"]["response"];
116116
};
117+
deleteSecretFromRepo: {
118+
parameters: RequestParameters &
119+
Omit<
120+
Endpoints["DELETE /repos/:owner/:repo/actions/secrets/:secret_name"]["parameters"],
121+
"baseUrl" | "headers" | "mediaType"
122+
>;
123+
response: Endpoints["DELETE /repos/:owner/:repo/actions/secrets/:secret_name"]["response"];
124+
};
117125
deleteSelfHostedRunnerFromOrg: {
118126
parameters: RequestParameters &
119127
Omit<

0 commit comments

Comments
 (0)