You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules/ROOT/pages/developer-reference.adoc
+21Lines changed: 21 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -349,6 +349,27 @@ The Quarkus GitHub App extension exposes the following configuration properties:
349
349
350
350
include::includes/quarkus-github-app.adoc[]
351
351
352
+
== Credentials provider
353
+
354
+
Quarkus GitHub App supports the usage of a https://quarkus.io/guides/credentials-provider[`CredentialsProvider`] to provide some of the configuration properties
355
+
that you might not want to appear in a configuration file.
356
+
357
+
You can find all the information you need about ``CredentialsProvider``s in the https://quarkus.io/guides/credentials-provider[dedicated guide].
358
+
359
+
The basic principle is that you provide a CDI bean that will implement the `CredentialsProvider` and will provide the values for the supported configuration properties.
360
+
It can either be provided by the https://github.com/quarkiverse/quarkus-vault[Vault extension] if you are using HashiCorp Vault or you can provide you own custom `CredentialsProvider` implementation.
361
+
362
+
Using a `CredentialsProvider` is easy:
363
+
364
+
- Make sure you have an implementation of `CredentialsProvider` and that it is a `@Singleton` or `@ApplicationScoped` CDI bean.
365
+
- Set the `quarkus.github-app.credentials-provider` to define the name of the credentials provider.
366
+
See it as the name of a keyring containing your Quarkus GitHub App secrets.
367
+
- For the given name, your `CredentialsProvider` may return a `Map` containing entries for `githubAppPrivateKey` and/or `githubAppWebhookSecret`.
368
+
You can use the constants present in `io.quarkiverse.githubapp.Credentials` for practicality.
369
+
370
+
That is all you need to do:
371
+
Quarkus GitHub App will then automatically use the values provided by the `CredentialsProvider` for the private key and the webhook secret.
0 commit comments