Skip to content

Commit de48886

Browse files
committed
Add more details to the documentation
1 parent c87b2fc commit de48886

File tree

2 files changed

+34
-1
lines changed

2 files changed

+34
-1
lines changed

docs/modules/ROOT/pages/developer-reference.adoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -419,6 +419,39 @@ public class MyGitHubCustomizer implements GitHubCustomizer {
419419
}
420420
----
421421

422+
This will apply the customizations to both the application clients and the installation clients.
423+
424+
However, some customizations can't be applied to the application clients such as configuring a rate limit checker.
425+
You may customize the application clients differently by implementing `customizeApplicationClient(GitHubBuilder)`:
426+
427+
[source,java]
428+
----
429+
@Singleton
430+
public class MyGitHubCustomizer implements GitHubCustomizer {
431+
432+
@Override
433+
public void customize(GitHubBuilder builder) { <1>
434+
// call methods of the builder
435+
}
436+
437+
@Override
438+
public void customizeApplicationClient(GitHubBuilder builder) { <2>
439+
// call methods of the builder
440+
}
441+
}
442+
----
443+
<1> Customize the installation clients.
444+
<2> Customize the application clients.
445+
446+
[NOTE]
447+
.About application and installation clients
448+
====
449+
A GitHub App relies on two types of GitHub clients:
450+
451+
- The application client: it is authenticated as the application, it has very few permissions and is mostly used to create installation-specific tokens.
452+
- The installation client: it is created specifically for an installation of the application (i.e. it is tied where the application is installed) and it is the client you consume in your GitHub App code. It has the permissions you defined for your GitHub App.
453+
====
454+
422455
== Configuration Reference
423456

424457
The Quarkus GitHub App extension exposes the following configuration properties:

docs/modules/ROOT/pages/includes/attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44
:github-api-javadoc-root-url: https://github-api.kohsuke.org/apidocs/org/kohsuke/github
55
:github-reference-documentation-root-url: https://docs.github.com/en/free-pro-team@latest/developers
66

7-
:command-airline-examples-dir: ./../examples/command/airline/
7+
:command-airline-examples-dir: ./../examples/command/airline/

0 commit comments

Comments
 (0)