Package io.quarkiverse.githubapp

Interface GitHubCustomizer

public interface GitHubCustomizer

Provide a CDI bean implementing this interface to customize GitHubBuilder used to create the GitHub instances.

Method Summary

Modifier and Type	Method	Description
void	customize(org.kohsuke.github.GitHubBuilder builder)	Customize the GitHubBuilder with various options.
default void	customizeApplicationClient(org.kohsuke.github.GitHubBuilder builder)	Customize the GitHubBuilder with various options specifically for the application client.

Method Details

customize

void customize(org.kohsuke.github.GitHubBuilder builder)

Customize the GitHubBuilder with various options.

These customizations are applied to both application and installation clients. Known cases of customizations that may be used with installation clients but not with application clients include configuring a rate limit checker. To use a different set of customizations for the application client, implement customizeApplicationClient(GitHubBuilder).

Note that customizations that use GitHubBuilder.withAppInstallationToken(String) and GitHubBuilder.withEndpoint(String) are eventually overridden by the GitHubService. Installation tokens are created and cached by the service.

To specify a custom endpoint, use configuration properties quarkus.github-app.instance-endpoint or quarkus.github-app.rest-api-endpoint.

Parameters:

builder - to customize

customizeApplicationClient

default void customizeApplicationClient(org.kohsuke.github.GitHubBuilder builder)

Customize the GitHubBuilder with various options specifically for the application client. Default implementation delegates to customize(GitHubBuilder) for backwards compatibility.

Note that customizations should never use GitHubBuilder.withAppInstallationToken(String), because this is the application client. Customizations that use GitHubBuilder.withJwtToken(String) and GitHubBuilder.withEndpoint(String) are eventually overridden by the service.

To specify a custom endpoint, use configuration properties quarkus.github-app.instance-endpoint or quarkus.github-app.rest-api-endpoint.

Parameters:

builder - to customize