Skip to content

Commit d63b83d

Browse files
mchammer01mchammer01
authored
Merge branch 'main' into mchammer01/more-broken-link-fixes
2 parents be358ad + e10baa3 commit d63b83d

13 files changed

Lines changed: 402 additions & 79 deletions

‎content/actions/reference/encrypted-secrets.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,12 @@ When generating credentials, we recommend that you grant the minimum permissions
7777

7878
If your repository {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0"or currentVersion == "github-ae@latest" %}has environment secrets or {% endif %}can access secrets from the parent organization, then those secrets are also listed on this page.
7979

80+
{% note %}
81+
82+
**Note:** Users with collaborator access can use the REST API to manage secrets for a repository. For more information, see "[{% data variables.product.prodname_actions %} secrets API](/rest/reference/actions#secrets)."
83+
84+
{% endnote %}
85+
8086
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" }
8187
### Creating encrypted secrets for an environment
8288

‎lib/rest/static/decorated/api.github.com.json‎

Lines changed: 228 additions & 20 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-2.20.json‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6316,14 +6316,17 @@
63166316
"properties": {
63176317
"access_token": {
63186318
"type": "string",
6319-
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
6319+
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
63206320
"name": "access_token",
63216321
"in": "body",
63226322
"rawType": "string",
63236323
"rawDescription": "The OAuth access token used to authenticate to the GitHub API.",
63246324
"childParamsGroups": []
63256325
}
6326-
}
6326+
},
6327+
"required": [
6328+
"access_token"
6329+
]
63276330
},
63286331
"example": {
63296332
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
@@ -6360,7 +6363,7 @@
63606363
"bodyParameters": [
63616364
{
63626365
"type": "string",
6363-
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
6366+
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
63646367
"name": "access_token",
63656368
"in": "body",
63666369
"rawType": "string",

‎lib/rest/static/decorated/ghes-2.21.json‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6310,14 +6310,17 @@
63106310
"properties": {
63116311
"access_token": {
63126312
"type": "string",
6313-
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
6313+
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
63146314
"name": "access_token",
63156315
"in": "body",
63166316
"rawType": "string",
63176317
"rawDescription": "The OAuth access token used to authenticate to the GitHub API.",
63186318
"childParamsGroups": []
63196319
}
6320-
}
6320+
},
6321+
"required": [
6322+
"access_token"
6323+
]
63216324
},
63226325
"example": {
63236326
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
@@ -6354,7 +6357,7 @@
63546357
"bodyParameters": [
63556358
{
63566359
"type": "string",
6357-
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
6360+
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
63586361
"name": "access_token",
63596362
"in": "body",
63606363
"rawType": "string",

‎lib/rest/static/decorated/ghes-2.22.json‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6390,14 +6390,17 @@
63906390
"properties": {
63916391
"access_token": {
63926392
"type": "string",
6393-
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
6393+
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
63946394
"name": "access_token",
63956395
"in": "body",
63966396
"rawType": "string",
63976397
"rawDescription": "The OAuth access token used to authenticate to the GitHub API.",
63986398
"childParamsGroups": []
63996399
}
6400-
}
6400+
},
6401+
"required": [
6402+
"access_token"
6403+
]
64016404
},
64026405
"example": {
64036406
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
@@ -6434,7 +6437,7 @@
64346437
"bodyParameters": [
64356438
{
64366439
"type": "string",
6437-
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
6440+
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
64386441
"name": "access_token",
64396442
"in": "body",
64406443
"rawType": "string",
@@ -16259,6 +16262,7 @@
1625916262
"encrypted_value": {
1626016263
"type": "string",
1626116264
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>",
16265+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
1626216266
"name": "encrypted_value",
1626316267
"in": "body",
1626416268
"rawType": "string",
@@ -16303,7 +16307,7 @@
1630316307
}
1630416308
},
1630516309
"example": {
16306-
"encrypted_value": "****************************************************************************************",
16310+
"encrypted_value": "c2VjcmV0",
1630716311
"key_id": "012345678912345678",
1630816312
"visibility": "selected",
1630916313
"selected_repository_ids": [
@@ -16344,6 +16348,7 @@
1634416348
{
1634516349
"type": "string",
1634616350
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>",
16351+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
1634716352
"name": "encrypted_value",
1634816353
"in": "body",
1634916354
"rawType": "string",
@@ -29639,6 +29644,7 @@
2963929644
"encrypted_value": {
2964029645
"type": "string",
2964129646
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>",
29647+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
2964229648
"name": "encrypted_value",
2964329649
"in": "body",
2964429650
"rawType": "string",
@@ -29657,7 +29663,7 @@
2965729663
}
2965829664
},
2965929665
"example": {
29660-
"encrypted_value": "****************************************************************************************",
29666+
"encrypted_value": "c2VjcmV0",
2966129667
"key_id": "012345678912345678"
2966229668
}
2966329669
}
@@ -29693,6 +29699,7 @@
2969329699
{
2969429700
"type": "string",
2969529701
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>",
29702+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
2969629703
"name": "encrypted_value",
2969729704
"in": "body",
2969829705
"rawType": "string",

‎lib/rest/static/decorated/ghes-3.0.json‎

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6592,14 +6592,17 @@
65926592
"properties": {
65936593
"access_token": {
65946594
"type": "string",
6595-
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
6595+
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
65966596
"name": "access_token",
65976597
"in": "body",
65986598
"rawType": "string",
65996599
"rawDescription": "The OAuth access token used to authenticate to the GitHub API.",
66006600
"childParamsGroups": []
66016601
}
6602-
}
6602+
},
6603+
"required": [
6604+
"access_token"
6605+
]
66036606
},
66046607
"example": {
66056608
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
@@ -6636,7 +6639,7 @@
66366639
"bodyParameters": [
66376640
{
66386641
"type": "string",
6639-
"description": "<p>The OAuth access token used to authenticate to the GitHub API.</p>",
6642+
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
66406643
"name": "access_token",
66416644
"in": "body",
66426645
"rawType": "string",
@@ -6691,7 +6694,7 @@
66916694
"properties": {
66926695
"access_token": {
66936696
"type": "string",
6694-
"description": "<p><strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>",
6697+
"description": "<p><strong>Required</strong>. <strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>",
66956698
"example": "e72e16c7e42f292c6912e7710c838347ae178b4a",
66966699
"name": "access_token",
66976700
"in": "body",
@@ -7551,7 +7554,10 @@
75517554
}
75527555
]
75537556
}
7554-
}
7557+
},
7558+
"required": [
7559+
"access_token"
7560+
]
75557561
}
75567562
}
75577563
}
@@ -7601,7 +7607,7 @@
76017607
"bodyParameters": [
76027608
{
76037609
"type": "string",
7604-
"description": "<p><strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>",
7610+
"description": "<p><strong>Required</strong>. <strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>",
76057611
"example": "e72e16c7e42f292c6912e7710c838347ae178b4a",
76067612
"name": "access_token",
76077613
"in": "body",
@@ -19946,6 +19952,7 @@
1994619952
"encrypted_value": {
1994719953
"type": "string",
1994819954
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>",
19955+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
1994919956
"name": "encrypted_value",
1995019957
"in": "body",
1995119958
"rawType": "string",
@@ -19990,7 +19997,7 @@
1999019997
}
1999119998
},
1999219999
"example": {
19993-
"encrypted_value": "****************************************************************************************",
20000+
"encrypted_value": "c2VjcmV0",
1999420001
"key_id": "012345678912345678",
1999520002
"visibility": "selected",
1999620003
"selected_repository_ids": [
@@ -20031,6 +20038,7 @@
2003120038
{
2003220039
"type": "string",
2003320040
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>",
20041+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
2003420042
"name": "encrypted_value",
2003520043
"in": "body",
2003620044
"rawType": "string",
@@ -33979,6 +33987,7 @@
3397933987
"encrypted_value": {
3398033988
"type": "string",
3398133989
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>",
33990+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
3398233991
"name": "encrypted_value",
3398333992
"in": "body",
3398433993
"rawType": "string",
@@ -33997,7 +34006,7 @@
3399734006
}
3399834007
},
3399934008
"example": {
34000-
"encrypted_value": "****************************************************************************************",
34009+
"encrypted_value": "c2VjcmV0",
3400134010
"key_id": "012345678912345678"
3400234011
}
3400334012
}
@@ -34033,6 +34042,7 @@
3403334042
{
3403434043
"type": "string",
3403534044
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>",
34045+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$",
3403634046
"name": "encrypted_value",
3403734047
"in": "body",
3403834048
"rawType": "string",

0 commit comments

Comments
 (0)