From dd18022eb5b0af0c9d401ee37b77a3487d8dad4b Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Thu, 27 Mar 2025 15:54:52 -0700 Subject: [PATCH 1/3] Update GitHub Enterprise Server documentation with additional repository and organization permissions --- docs/platforms/github-enterprise-server.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/platforms/github-enterprise-server.md b/docs/platforms/github-enterprise-server.md index cb0e8084..9050e49d 100644 --- a/docs/platforms/github-enterprise-server.md +++ b/docs/platforms/github-enterprise-server.md @@ -92,10 +92,12 @@ steps below to - **Repository permissions**: - **Checks**: Read-only - **Contents**: Read and write + - **Commit statuses**: Read and write - **Discussions**: Read-only - **Issues**: Read and write - **Metadata**: Read-only - **Pull requests**: Read and write + - **Actions**: Read-only - **Organization permissions**: - **Members**: Read-only - **Events**: From af540018131a648d3ee2ef45111de3e53512ae5c Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Thu, 27 Mar 2025 16:02:45 -0700 Subject: [PATCH 2/3] Refactor GitHub App configuration for improved clarity and organization --- docs/platforms/github-enterprise-server.md | 66 +++++++++++----------- 1 file changed, 34 insertions(+), 32 deletions(-) diff --git a/docs/platforms/github-enterprise-server.md b/docs/platforms/github-enterprise-server.md index 9050e49d..985cc108 100644 --- a/docs/platforms/github-enterprise-server.md +++ b/docs/platforms/github-enterprise-server.md @@ -80,38 +80,40 @@ steps below to 3. In the left sidebar, click **Developer settings** > **GitHub Apps** 4. Click **New GitHub App**. 5. Set the following fields: - - **GitHub App name**: `CodeRabbit` - - **Description**: `GitHub App for CodeRabbit` - - **Homepage URL**: `https://coderabbit.ai` - - **Callback URL**: `https://app.coderabbit.ai/login` - - **Request user authorization (OAuth) during installation**: `true` - - **Webhook Active**: `true` - - **Webhook URL**: `https://app.coderabbit.ai/githubHandler` - - **Webhook secret**: Use a secure string and keep it handy. - - **Permissions**: - - **Repository permissions**: - - **Checks**: Read-only - - **Contents**: Read and write - - **Commit statuses**: Read and write - - **Discussions**: Read-only - - **Issues**: Read and write - - **Metadata**: Read-only - - **Pull requests**: Read and write - - **Actions**: Read-only - - **Organization permissions**: - - **Members**: Read-only - - **Events**: - - Meta - - Issue comment - - Issues - - Label - - Public - - Pull request - - Pull request review - - Pull request review comment - - Pull request review thread - - Push - - Release + +- **GitHub App name**: `CodeRabbit` +- **Description**: `GitHub App for CodeRabbit` +- **Homepage URL**: `https://coderabbit.ai` +- **Callback URL**: `https://app.coderabbit.ai/login` +- **Request user authorization (OAuth) during installation**: `true` +- **Webhook Active**: `true` +- **Webhook URL**: `https://app.coderabbit.ai/githubHandler` +- **Webhook secret**: Use a secure string and keep it handy. +- **Permissions**: + - *Repository permissions*: + - Actions: Read-only + - Checks: Read-only + - Contents: Read and write + - Commit statuses: Read and write + - Discussions: Read-only + - Issues: Read and write + - Metadata: Read-only + - Pull requests: Read and write + - *Organization permissions*: + - Members: Read-only +- **Events**: + - Meta + - Issue comment + - Issues + - Label + - Public + - Pull request + - Pull request review + - Pull request review comment + - Pull request review thread + - Push + - Release + 6. Click **Create GitHub App**. Once the GitHub App has been created, click on **Generate a new client secret** From 6c132c19d528da436309ca7355629bf92dbe7fdc Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Thu, 27 Mar 2025 16:54:36 -0700 Subject: [PATCH 3/3] Improve formatting and organization of GitHub App configuration instructions --- docs/platforms/github-enterprise-server.md | 69 +++++++++++----------- 1 file changed, 33 insertions(+), 36 deletions(-) diff --git a/docs/platforms/github-enterprise-server.md b/docs/platforms/github-enterprise-server.md index 985cc108..35f459bb 100644 --- a/docs/platforms/github-enterprise-server.md +++ b/docs/platforms/github-enterprise-server.md @@ -75,45 +75,42 @@ steps below to [create a GitHub App](https://docs.github.com/en/enterprise-server@latest/apps/creating-github-apps/registering-a-github-app/registering-a-github-app): 1. Sign in to your GitHub Enterprise account. -2. In the upper-right corner of any page, click your profile photo, then click - **Settings**. +2. In the upper-right corner of any page, click your profile photo, then click **Settings**. 3. In the left sidebar, click **Developer settings** > **GitHub Apps** 4. Click **New GitHub App**. 5. Set the following fields: - -- **GitHub App name**: `CodeRabbit` -- **Description**: `GitHub App for CodeRabbit` -- **Homepage URL**: `https://coderabbit.ai` -- **Callback URL**: `https://app.coderabbit.ai/login` -- **Request user authorization (OAuth) during installation**: `true` -- **Webhook Active**: `true` -- **Webhook URL**: `https://app.coderabbit.ai/githubHandler` -- **Webhook secret**: Use a secure string and keep it handy. -- **Permissions**: - - *Repository permissions*: - - Actions: Read-only - - Checks: Read-only - - Contents: Read and write - - Commit statuses: Read and write - - Discussions: Read-only - - Issues: Read and write - - Metadata: Read-only - - Pull requests: Read and write - - *Organization permissions*: - - Members: Read-only -- **Events**: - - Meta - - Issue comment - - Issues - - Label - - Public - - Pull request - - Pull request review - - Pull request review comment - - Pull request review thread - - Push - - Release - + - **GitHub App name**: `CodeRabbit` + - **Description**: `GitHub App for CodeRabbit` + - **Homepage URL**: `https://coderabbit.ai` + - **Callback URL**: `https://app.coderabbit.ai/login` + - **Request user authorization (OAuth) during installation**: `true` + - **Webhook Active**: `true` + - **Webhook URL**: `https://app.coderabbit.ai/githubHandler` + - **Webhook secret**: Use a secure string and keep it handy. + - **Permissions**: + - **Repository permissions**: + - **Actions**: Read-only + - **Checks**: Read-only + - **Contents**: Read and write + - **Commit statuses**: Read and write + - **Discussions**: Read-only + - **Issues**: Read and write + - **Metadata**: Read-only + - **Pull requests**: Read and write + - **Organization permissions**: + - **Members**: Read-only + - **Events**: + - Meta + - Issue comment + - Issues + - Label + - Public + - Pull request + - Pull request review + - Pull request review comment + - Pull request review thread + - Push + - Release 6. Click **Create GitHub App**. Once the GitHub App has been created, click on **Generate a new client secret**