Create configuration property for the HTTP path of the route that listens for webhook events

Author: ryandens

docs/modules/ROOT/pages/includes/quarkus-github-app.adoc

@@ -85,6 +85,25 @@ endif::add-copy-button-to-env-var[]
 |
 
 
+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]`
+
+
+[.description]
+--
+The webhook URL path that the GitHub App listens to, prefixed with the "/" character.
+
+This defaults to the root "/" but could be configured to a something else to enable deployment alongside other HTTP routes. such as "/github-event"
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_WEBHOOK_URL_PATH+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_GITHUB_APP_WEBHOOK_URL_PATH+++`
+endif::add-copy-button-to-env-var[]
+--|string 
+|`/`
+
+
 a| [[quarkus-github-app_quarkus-github-app-webhook-secret]]`link:#quarkus-github-app_quarkus-github-app-webhook-secret[quarkus.github-app.webhook-secret]`
 
 

runtime/src/main/java/io/quarkiverse/githubapp/runtime/Routes.java

@@ -73,7 +73,7 @@ public void init(@Observes StartupEvent startupEvent) throws IOException {
     }
 
     public void init(@Observes Router router) {
-        router.post("/")
+        router.post(checkedConfigProvider.webhookUrlPath())
                 .handler(BodyHandler.create()) // this is required so that the body to be read by subsequent handlers
                 .blockingHandler(routingContext -> {
                     try {

runtime/src/main/java/io/quarkiverse/githubapp/runtime/config/CheckedConfigProvider.java

@@ -108,6 +108,10 @@ public String restApiEndpoint() {
         return gitHubAppRuntimeConfig.restApiEndpoint;
     }
 
+    public String webhookUrlPath() {
+        return gitHubAppRuntimeConfig.webhookUrlPath;
+    }
+
     public String graphqlApiEndpoint() {
         return gitHubAppRuntimeConfig.graphqlApiEndpoint;
     }

runtime/src/main/java/io/quarkiverse/githubapp/runtime/config/GitHubAppRuntimeConfig.java

@@ -46,6 +46,15 @@ public class GitHubAppRuntimeConfig {
     @ConvertWith(PrivateKeyConverter.class)
     Optional<PrivateKey> privateKey;
 
+    /**
+     * The webhook URL path that the GitHub App listens to, prefixed with the "/" character.
+     * <p>
+     * This defaults to the root "/" but could be configured to a something else to enable deployment alongside other HTTP
+     * routes. such as "/github-event"
+     */
+    @ConfigItem(defaultValue = "/")
+    String webhookUrlPath;
+
     /**
      * The webhook secret if defined in the GitHub UI.
      */

runtime/src/main/java/io/quarkiverse/githubapp/runtime/smee/SmeeIoForwarder.java

@@ -50,7 +50,8 @@ public class SmeeIoForwarder {
 
         LOG.info("Listening to events coming from " + checkedConfigProvider.webhookProxyUrl().get());
 
-        URI localUrl = URI.create("http://" + httpConfiguration.host + ":" + httpConfiguration.port + "/");
+        URI localUrl = URI.create(
+                "http://" + httpConfiguration.host + ":" + httpConfiguration.port + checkedConfigProvider.webhookUrlPath());
 
         this.replayEventStreamAdapter = new ReplayEventStreamAdapter(checkedConfigProvider.webhookProxyUrl().get(), localUrl,
                 objectMapper);