Skip to content

Commit 4821e4d

Browse files
committed
docs(config): clarify optional GitHub App installation ID
1 parent 3269f60 commit 4821e4d

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

runtime/values-multi-nodes.yaml.example

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ custom:
111111
# - Webhook: off
112112
# 2. Update hub.config.GitHubOAuthenticator:
113113
# app_id: "<GitHub App App ID>"
114-
# installation_id: "<GitHub App Installation ID>"
114+
# installation_id: "<GitHub App Installation ID>" # Optional; leave blank to auto-discover from the org installation
115115
# private_key_file: "<Mounted GitHub App private key path>"
116116
# client_id: "<GitHub App Client ID>"
117117
# client_secret: "<GitHub App Client Secret>"
@@ -376,6 +376,7 @@ hub:
376376
GitHubOAuthenticator:
377377
oauth_callback_url: "https://your.domain.com/hub/github/oauth_callback"
378378
app_id: ""
379+
# Optional; leave blank when the GitHub App is installed on the org and the Hub can auto-discover it.
379380
installation_id: ""
380381
private_key_file: ""
381382
private_key: ""

runtime/values.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ custom:
155155
# - Webhook: off
156156
# 2. Update hub.config.GitHubOAuthenticator:
157157
# app_id: "<GitHub App App ID>"
158-
# installation_id: "<GitHub App Installation ID>"
158+
# installation_id: "<GitHub App Installation ID>" # Optional; leave blank to auto-discover from the org installation
159159
# private_key_file: "<Mounted GitHub App private key path>"
160160
# client_id: "<GitHub App Client ID>"
161161
# client_secret: "<GitHub App Client Secret>"
@@ -467,6 +467,7 @@ hub:
467467
GitHubOAuthenticator:
468468
oauth_callback_url: "https://<Your.domain>/hub/github/oauth_callback"
469469
app_id: ""
470+
# Optional; leave blank when the GitHub App is installed on the org and the Hub can auto-discover it.
470471
installation_id: ""
471472
private_key_file: ""
472473
private_key: ""

0 commit comments

Comments
 (0)