Skip to content

Commit ca30f6d

Browse files
authored
Merge pull request #738 from gsmet/new-config-infra
Switch to the new config infrastructure
2 parents cb67607 + 5ed830e commit ca30f6d

File tree

4 files changed

+355
-70
lines changed

4 files changed

+355
-70
lines changed
Lines changed: 62 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,129 +1,124 @@
1-
2-
:summaryTableId: quarkus-github-app
1+
:summaryTableId: quarkus-github-app_quarkus-github-app
32
[.configuration-legend]
43
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
54
[.configuration-reference.searchable, cols="80,.^10,.^10"]
65
|===
76

8-
h|[[quarkus-github-app_configuration]]link:#quarkus-github-app_configuration[Configuration property]
9-
7+
h|[.header-title]##Configuration property##
108
h|Type
119
h|Default
1210

13-
a| [[quarkus-github-app_quarkus-github-app-app-id]]`link:#quarkus-github-app_quarkus-github-app-app-id[quarkus.github-app.app-id]`
14-
11+
a| [[quarkus-github-app_quarkus-github-app-app-id]] [.property-path]##link:#quarkus-github-app_quarkus-github-app-app-id[`quarkus.github-app.app-id`]##
1512

1613
[.description]
1714
--
1815
The numeric application id provided by GitHub.
1916

2017
Optional for tests, but mandatory in production and dev mode.
2118

19+
2220
ifdef::add-copy-button-to-env-var[]
2321
Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_APP_ID+++[]
2422
endif::add-copy-button-to-env-var[]
2523
ifndef::add-copy-button-to-env-var[]
2624
Environment variable: `+++QUARKUS_GITHUB_APP_APP_ID+++`
2725
endif::add-copy-button-to-env-var[]
28-
--|string
26+
--
27+
|string
2928
|
3029

31-
32-
a| [[quarkus-github-app_quarkus-github-app-app-name]]`link:#quarkus-github-app_quarkus-github-app-app-name[quarkus.github-app.app-name]`
33-
30+
a| [[quarkus-github-app_quarkus-github-app-app-name]] [.property-path]##link:#quarkus-github-app_quarkus-github-app-app-name[`quarkus.github-app.app-name`]##
3431

3532
[.description]
3633
--
3734
The GitHub name of the application.
3835

3936
Optional, only used for improving the user experience.
4037

38+
4139
ifdef::add-copy-button-to-env-var[]
4240
Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_APP_NAME+++[]
4341
endif::add-copy-button-to-env-var[]
4442
ifndef::add-copy-button-to-env-var[]
4543
Environment variable: `+++QUARKUS_GITHUB_APP_APP_NAME+++`
4644
endif::add-copy-button-to-env-var[]
47-
--|string
45+
--
46+
|string
4847
|
4948

50-
51-
a| [[quarkus-github-app_quarkus-github-app-read-config-files-from-source-repository]]`link:#quarkus-github-app_quarkus-github-app-read-config-files-from-source-repository[quarkus.github-app.read-config-files-from-source-repository]`
52-
49+
a| [[quarkus-github-app_quarkus-github-app-read-config-files-from-source-repository]] [.property-path]##link:#quarkus-github-app_quarkus-github-app-read-config-files-from-source-repository[`quarkus.github-app.read-config-files-from-source-repository`]##
5350

5451
[.description]
5552
--
5653
Read the configuration files from the source repository in case of a fork.
5754

55+
5856
ifdef::add-copy-button-to-env-var[]
5957
Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_READ_CONFIG_FILES_FROM_SOURCE_REPOSITORY+++[]
6058
endif::add-copy-button-to-env-var[]
6159
ifndef::add-copy-button-to-env-var[]
6260
Environment variable: `+++QUARKUS_GITHUB_APP_READ_CONFIG_FILES_FROM_SOURCE_REPOSITORY+++`
6361
endif::add-copy-button-to-env-var[]
64-
--|boolean
62+
--
63+
|boolean
6564
|`false`
6665

67-
68-
a| [[quarkus-github-app_quarkus-github-app-private-key]]`link:#quarkus-github-app_quarkus-github-app-private-key[quarkus.github-app.private-key]`
69-
66+
a| [[quarkus-github-app_quarkus-github-app-private-key]] [.property-path]##link:#quarkus-github-app_quarkus-github-app-private-key[`quarkus.github-app.private-key`]##
7067

7168
[.description]
7269
--
7370
The RSA private key.
7471

7572
Optional for tests, but mandatory in production and dev mode.
7673

74+
7775
ifdef::add-copy-button-to-env-var[]
7876
Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_PRIVATE_KEY+++[]
7977
endif::add-copy-button-to-env-var[]
8078
ifndef::add-copy-button-to-env-var[]
8179
Environment variable: `+++QUARKUS_GITHUB_APP_PRIVATE_KEY+++`
8280
endif::add-copy-button-to-env-var[]
83-
--|link:https://docs.oracle.com/javase/8/docs/api/java/security/PrivateKey.html[PrivateKey]
84-
81+
--
82+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/security/PrivateKey.html[PrivateKey]
8583
|
8684

87-
88-
a| [[quarkus-github-app_quarkus-github-app-webhook-url-path]]`link:#quarkus-github-app_quarkus-github-app-webhook-url-path[quarkus.github-app.webhook-url-path]`
89-
85+
a| [[quarkus-github-app_quarkus-github-app-webhook-url-path]] [.property-path]##link:#quarkus-github-app_quarkus-github-app-webhook-url-path[`quarkus.github-app.webhook-url-path`]##
9086

9187
[.description]
9288
--
9389
The webhook URL path on which the GitHub App route is mounted.
9490

9591
It defaults to the root `/` but it can be configured to another path such as `/github-events` to enable deployment alongside other HTTP routes.
9692

93+
9794
ifdef::add-copy-button-to-env-var[]
9895
Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_WEBHOOK_URL_PATH+++[]
9996
endif::add-copy-button-to-env-var[]
10097
ifndef::add-copy-button-to-env-var[]
10198
Environment variable: `+++QUARKUS_GITHUB_APP_WEBHOOK_URL_PATH+++`
10299
endif::add-copy-button-to-env-var[]
103-
--|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String]
104-
100+
--
101+
|string
105102
|`/`
106103

107-
108-
a| [[quarkus-github-app_quarkus-github-app-webhook-secret]]`link:#quarkus-github-app_quarkus-github-app-webhook-secret[quarkus.github-app.webhook-secret]`
109-
104+
a| [[quarkus-github-app_quarkus-github-app-webhook-secret]] [.property-path]##link:#quarkus-github-app_quarkus-github-app-webhook-secret[`quarkus.github-app.webhook-secret`]##
110105

111106
[.description]
112107
--
113108
The webhook secret if defined in the GitHub UI.
114109

110+
115111
ifdef::add-copy-button-to-env-var[]
116112
Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_WEBHOOK_SECRET+++[]
117113
endif::add-copy-button-to-env-var[]
118114
ifndef::add-copy-button-to-env-var[]
119115
Environment variable: `+++QUARKUS_GITHUB_APP_WEBHOOK_SECRET+++`
120116
endif::add-copy-button-to-env-var[]
121-
--|string
117+
--
118+
|string
122119
|
123120

124-
125-
a| [[quarkus-github-app_quarkus-github-app-credentials-provider]]`link:#quarkus-github-app_quarkus-github-app-credentials-provider[quarkus.github-app.credentials-provider]`
126-
121+
a| [[quarkus-github-app_quarkus-github-app-credentials-provider]] [.property-path]##link:#quarkus-github-app_quarkus-github-app-credentials-provider[`quarkus.github-app.credentials-provider`]##
127122

128123
[.description]
129124
--
@@ -133,18 +128,18 @@ This is the name of the "keyring" containing the GitHub App secrets.
133128

134129
Key names are defined in `Credentials`.
135130

131+
136132
ifdef::add-copy-button-to-env-var[]
137133
Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_CREDENTIALS_PROVIDER+++[]
138134
endif::add-copy-button-to-env-var[]
139135
ifndef::add-copy-button-to-env-var[]
140136
Environment variable: `+++QUARKUS_GITHUB_APP_CREDENTIALS_PROVIDER+++`
141137
endif::add-copy-button-to-env-var[]
142-
--|string
138+
--
139+
|string
143140
|
144141

145-
146-
a| [[quarkus-github-app_quarkus-github-app-credentials-provider-name]]`link:#quarkus-github-app_quarkus-github-app-credentials-provider-name[quarkus.github-app.credentials-provider-name]`
147-
142+
a| [[quarkus-github-app_quarkus-github-app-credentials-provider-name]] [.property-path]##link:#quarkus-github-app_quarkus-github-app-credentials-provider-name[`quarkus.github-app.credentials-provider-name`]##
148143

149144
[.description]
150145
--
@@ -154,95 +149,92 @@ This is a bean name (as in `@Named`) of a bean that implements `CredentialsProvi
154149

155150
For Vault, the credentials provider bean name is `vault-credentials-provider`.
156151

152+
157153
ifdef::add-copy-button-to-env-var[]
158154
Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_CREDENTIALS_PROVIDER_NAME+++[]
159155
endif::add-copy-button-to-env-var[]
160156
ifndef::add-copy-button-to-env-var[]
161157
Environment variable: `+++QUARKUS_GITHUB_APP_CREDENTIALS_PROVIDER_NAME+++`
162158
endif::add-copy-button-to-env-var[]
163-
--|string
159+
--
160+
|string
164161
|
165162

166-
167-
a| [[quarkus-github-app_quarkus-github-app-webhook-proxy-url]]`link:#quarkus-github-app_quarkus-github-app-webhook-proxy-url[quarkus.github-app.webhook-proxy-url]`
168-
163+
a| [[quarkus-github-app_quarkus-github-app-webhook-proxy-url]] [.property-path]##link:#quarkus-github-app_quarkus-github-app-webhook-proxy-url[`quarkus.github-app.webhook-proxy-url`]##
169164

170165
[.description]
171166
--
172167
The Smee.io proxy URL used when testing locally.
173168

169+
174170
ifdef::add-copy-button-to-env-var[]
175171
Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_WEBHOOK_PROXY_URL+++[]
176172
endif::add-copy-button-to-env-var[]
177173
ifndef::add-copy-button-to-env-var[]
178174
Environment variable: `+++QUARKUS_GITHUB_APP_WEBHOOK_PROXY_URL+++`
179175
endif::add-copy-button-to-env-var[]
180-
--|string
176+
--
177+
|string
181178
|
182179

183-
184-
a| [[quarkus-github-app_quarkus-github-app-instance-endpoint]]`link:#quarkus-github-app_quarkus-github-app-instance-endpoint[quarkus.github-app.instance-endpoint]`
185-
180+
a| [[quarkus-github-app_quarkus-github-app-instance-endpoint]] [.property-path]##link:#quarkus-github-app_quarkus-github-app-instance-endpoint[`quarkus.github-app.instance-endpoint`]##
186181

187182
[.description]
188183
--
189184
The GitHub instance endpoint.
190185

191186
Defaults to the public github.com instance.
192187

188+
193189
ifdef::add-copy-button-to-env-var[]
194190
Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_INSTANCE_ENDPOINT+++[]
195191
endif::add-copy-button-to-env-var[]
196192
ifndef::add-copy-button-to-env-var[]
197193
Environment variable: `+++QUARKUS_GITHUB_APP_INSTANCE_ENDPOINT+++`
198194
endif::add-copy-button-to-env-var[]
199-
--|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String]
200-
195+
--
196+
|string
201197
|`https://api.github.com`
202198

203-
204-
a| [[quarkus-github-app_quarkus-github-app-rest-api-endpoint]]`link:#quarkus-github-app_quarkus-github-app-rest-api-endpoint[quarkus.github-app.rest-api-endpoint]`
205-
199+
a| [[quarkus-github-app_quarkus-github-app-rest-api-endpoint]] [.property-path]##link:#quarkus-github-app_quarkus-github-app-rest-api-endpoint[`quarkus.github-app.rest-api-endpoint`]##
206200

207201
[.description]
208202
--
209203
The REST API endpoint.
210204

211205
Defaults to the public github.com instance REST API endpoint.
212206

207+
213208
ifdef::add-copy-button-to-env-var[]
214209
Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_REST_API_ENDPOINT+++[]
215210
endif::add-copy-button-to-env-var[]
216211
ifndef::add-copy-button-to-env-var[]
217212
Environment variable: `+++QUARKUS_GITHUB_APP_REST_API_ENDPOINT+++`
218213
endif::add-copy-button-to-env-var[]
219-
--|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String]
220-
214+
--
215+
|string
221216
|`${quarkus.github-app.instance-endpoint}`
222217

223-
224-
a| [[quarkus-github-app_quarkus-github-app-graphql-api-endpoint]]`link:#quarkus-github-app_quarkus-github-app-graphql-api-endpoint[quarkus.github-app.graphql-api-endpoint]`
225-
218+
a| [[quarkus-github-app_quarkus-github-app-graphql-api-endpoint]] [.property-path]##link:#quarkus-github-app_quarkus-github-app-graphql-api-endpoint[`quarkus.github-app.graphql-api-endpoint`]##
226219

227220
[.description]
228221
--
229222
The GraphQL API endpoint.
230223

231224
Defaults to the public github.com instance GraphQL endpoint.
232225

226+
233227
ifdef::add-copy-button-to-env-var[]
234228
Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_GRAPHQL_API_ENDPOINT+++[]
235229
endif::add-copy-button-to-env-var[]
236230
ifndef::add-copy-button-to-env-var[]
237231
Environment variable: `+++QUARKUS_GITHUB_APP_GRAPHQL_API_ENDPOINT+++`
238232
endif::add-copy-button-to-env-var[]
239-
--|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String]
240-
233+
--
234+
|string
241235
|`${quarkus.github-app.instance-endpoint}/graphql`
242236

243-
244-
a| [[quarkus-github-app_quarkus-github-app-personal-access-token]]`link:#quarkus-github-app_quarkus-github-app-personal-access-token[quarkus.github-app.personal-access-token]`
245-
237+
a| [[quarkus-github-app_quarkus-github-app-personal-access-token]] [.property-path]##link:#quarkus-github-app_quarkus-github-app-personal-access-token[`quarkus.github-app.personal-access-token`]##
246238

247239
[.description]
248240
--
@@ -254,30 +246,35 @@ However, if your payload comes from a webhook and doesn't have an installation i
254246

255247
This token will be used to authenticate the clients provided by `TokenGitHubClients` and clients authenticated with this personal access token will be automatically provided when injecting `GitHub` or `DynamicGraphQLClient` in your method, when the payload doesn't provide an installation id.
256248

249+
257250
ifdef::add-copy-button-to-env-var[]
258251
Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_PERSONAL_ACCESS_TOKEN+++[]
259252
endif::add-copy-button-to-env-var[]
260253
ifndef::add-copy-button-to-env-var[]
261254
Environment variable: `+++QUARKUS_GITHUB_APP_PERSONAL_ACCESS_TOKEN+++`
262255
endif::add-copy-button-to-env-var[]
263-
--|string
256+
--
257+
|string
264258
|
265259

266-
267-
a| [[quarkus-github-app_quarkus-github-app-debug-payload-directory]]`link:#quarkus-github-app_quarkus-github-app-debug-payload-directory[quarkus.github-app.debug.payload-directory]`
268-
260+
a| [[quarkus-github-app_quarkus-github-app-debug-payload-directory]] [.property-path]##link:#quarkus-github-app_quarkus-github-app-debug-payload-directory[`quarkus.github-app.debug.payload-directory`]##
269261

270262
[.description]
271263
--
272264
A directory in which the payloads are saved.
273265

266+
274267
ifdef::add-copy-button-to-env-var[]
275268
Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_DEBUG_PAYLOAD_DIRECTORY+++[]
276269
endif::add-copy-button-to-env-var[]
277270
ifndef::add-copy-button-to-env-var[]
278271
Environment variable: `+++QUARKUS_GITHUB_APP_DEBUG_PAYLOAD_DIRECTORY+++`
279272
endif::add-copy-button-to-env-var[]
280-
--|path
273+
--
274+
|path
281275
|
282276

283-
|===
277+
|===
278+
279+
280+
:!summaryTableId:

0 commit comments

Comments
 (0)