From c634f7ac4bc1f150fc3843bae079629070f6fdae Mon Sep 17 00:00:00 2001 From: Spikatrix <12792882+Spikatrix@users.noreply.github.com> Date: Wed, 24 Jul 2024 09:23:07 +0000 Subject: [PATCH 1/4] Add step to install GitHub App --- docs/integrations/self-hosted-github.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/integrations/self-hosted-github.md b/docs/integrations/self-hosted-github.md index 975a826b..f23a5add 100644 --- a/docs/integrations/self-hosted-github.md +++ b/docs/integrations/self-hosted-github.md @@ -61,7 +61,7 @@ Navigate to your GitHub Self-Hosted Instance and follow the steps below to [crea 3. In the left sidebar, click **Developer settings** > **GitHub Apps** 4. Click **New GitHub App**. 5. Set the following fields: - - **GitHub App name**: `CodeRabbit GitHub App` + - **GitHub App name**: `CodeRabbit` - **Description**: `GitHub App for CodeRabbit` - **Homepage URL**: `https://coderabbit.ai` - **Callback URL**: `https://app.coderabbit.ai/login` @@ -97,8 +97,6 @@ Once the GitHub App has been created, click on **Generate a new client secret** Scroll down and click on **Generate a private key** under the 'Private keys' section and download the PEM file. -Also, from the **Install App** tab, install the GitHub App to your organizations. - Keep the following details handy: - App ID @@ -122,10 +120,22 @@ Submit the details that were accumulated in previous steps: - GitHub App Webhook Secret - GitHub App Private Key -Click on Submit and the login process will be initiated. +Click on Submit and the login process will be initiated. On subsequent visits, your setup will be automatically detected, allowing for direct login. -### **Step 5: Whitelist CodeRabbit IP address** +### **Step 5: Install the GitHub App** + +Navigate to the GitHub App that was created from your self-hosted instance and click on the **Install App** tab. +Then, install the GitHub App to your organization(s). + +:::warning + +If you performed this step before Step 4, the install event likely will have failed and you will need to re-send the installation event. +Navigate to the **Advanced** tab in the GitHub App and click on the **Redeliver** button for the failed `installation.created` event. + +::: + +### **Step 6: Whitelist CodeRabbit IP address** Use this CodeRabbit IP if your instance requires IP whitelisting `35.222.179.152/32` From ac1de99613ad23d3bf701900901e22c24c5331d8 Mon Sep 17 00:00:00 2001 From: Spikatrix <12792882+Spikatrix@users.noreply.github.com> Date: Wed, 24 Jul 2024 12:05:36 +0000 Subject: [PATCH 2/4] Disclaimer --- docs/integrations/self-hosted-github.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/integrations/self-hosted-github.md b/docs/integrations/self-hosted-github.md index f23a5add..14902163 100644 --- a/docs/integrations/self-hosted-github.md +++ b/docs/integrations/self-hosted-github.md @@ -5,6 +5,13 @@ sidebar_label: Self-Managed GitHub sidebar_position: 3 --- +:::info + +This page is for GitHub Enterprise Self-Hosted users only. +If you're using github.com, [login to CodeRabbit](https://app.coderabbit.ai) and add your repositories from there + +::: + This page guides you through the process of integrating your Self-Managed GitHub with CodeRabbit. To initiate the integration, we require specific information. This is essential From fd11d90f5ea7a2bec3f0e87ff01d5aa61dbc7c1e Mon Sep 17 00:00:00 2001 From: Spikatrix <12792882+Spikatrix@users.noreply.github.com> Date: Wed, 24 Jul 2024 12:18:02 +0000 Subject: [PATCH 3/4] Coderabbit suggestion: install -> installation --- docs/integrations/self-hosted-github.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/self-hosted-github.md b/docs/integrations/self-hosted-github.md index 14902163..4b624c93 100644 --- a/docs/integrations/self-hosted-github.md +++ b/docs/integrations/self-hosted-github.md @@ -137,7 +137,7 @@ Then, install the GitHub App to your organization(s). :::warning -If you performed this step before Step 4, the install event likely will have failed and you will need to re-send the installation event. +If you performed this step before Step 4, the installation event likely will have failed and you will need to re-send the installation event. Navigate to the **Advanced** tab in the GitHub App and click on the **Redeliver** button for the failed `installation.created` event. ::: From 4e7dd5acaedc2e75aceeff70374a2af40153b251 Mon Sep 17 00:00:00 2001 From: Spikatrix <12792882+Spikatrix@users.noreply.github.com> Date: Wed, 24 Jul 2024 12:35:25 +0000 Subject: [PATCH 4/4] Coderabbit suggestions --- docs/integrations/self-hosted-github.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/integrations/self-hosted-github.md b/docs/integrations/self-hosted-github.md index 4b624c93..78f21cb0 100644 --- a/docs/integrations/self-hosted-github.md +++ b/docs/integrations/self-hosted-github.md @@ -8,7 +8,7 @@ sidebar_position: 3 :::info This page is for GitHub Enterprise Self-Hosted users only. -If you're using github.com, [login to CodeRabbit](https://app.coderabbit.ai) and add your repositories from there +If you're using github.com, [log in to CodeRabbit](https://app.coderabbit.ai) and add your repositories from there ::: @@ -137,7 +137,7 @@ Then, install the GitHub App to your organization(s). :::warning -If you performed this step before Step 4, the installation event likely will have failed and you will need to re-send the installation event. +If you performed this step before Step 4, the installation event likely will have failed, and you will need to re-send the installation event. Navigate to the **Advanced** tab in the GitHub App and click on the **Redeliver** button for the failed `installation.created` event. :::