Skip to content

Commit 6d83f7c

Browse files
committed
Github -> GitHub
1 parent 71f9429 commit 6d83f7c

File tree

2 files changed

+39
-20
lines changed

2 files changed

+39
-20
lines changed

docs/platforms/github-enterprise-server.md

+36-18
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
---
22
title: CodeRabbit for GitHub Enterprise Server
33
description: Integrate CodeRabbit with your GitHub Enterprise Server.
4-
sidebar_label: Github Enteprise Server
4+
sidebar_label: GitHub Enterprise Server
55
sidebar_position: 3
66
---
77

88
:::info
99

1010
This page is for GitHub Enterprise Server (Self-Hosted) users only.
11-
If you're using github.com, [log in to CodeRabbit](https://app.coderabbit.ai) and add your repositories from there
11+
If you're using github.com, [log in to CodeRabbit](https://app.coderabbit.ai)
12+
and add your repositories from there
1213

1314
:::
1415

15-
This page guides you through the process of integrating your Self-Managed GitHub with CodeRabbit.
16+
This page guides you through the process of integrating your Self-Managed GitHub
17+
with CodeRabbit.
1618

1719
To initiate the integration, we require specific information. This is essential
1820
for the initial setup of CodeRabbit within your domain. Once this setup is
@@ -31,26 +33,33 @@ organization and if we find an existing one, we will start the login process.
3133

3234
![Untitled](/img/integrations/self-hosted-github-host-url.png)
3335

34-
If the self-managed GitHub instance is not found, you will be required to enter more details for the onboarding.
36+
If the self-managed GitHub instance is not found, you will be required to enter
37+
more details for the onboarding.
3538

3639
### **Step 2: GitHub OAuth App**
3740

38-
Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the steps below to [create an OAuth App](https://docs.github.com/en/enterprise-server@latest/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app):
41+
Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the
42+
steps below to
43+
[create an OAuth App](https://docs.github.com/en/enterprise-server@latest/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app):
3944

4045
1. Sign in to your GitHub Enterprise account.
41-
2. In the upper-right corner of any page, click your profile photo, then click **Settings**.
46+
2. In the upper-right corner of any page, click your profile photo, then click
47+
**Settings**.
4248
3. In the left sidebar, click **Developer settings** > **OAuth Apps**.
4349
4. Click **New OAuth App**.
4450
5. Set the following fields:
4551
- **Application name**: `CodeRabbit OAuth`
4652
- **Homepage URL**: `https://coderabbit.ai`
47-
- **Application description**: `OAuth application for signing into CodeRabbit`
53+
- **Application description**:
54+
`OAuth application for signing into CodeRabbit`
4855
- **Authorization callback URL**: `https://app.coderabbit.ai/login`
4956
6. Click **Register application**.
5057

5158
![GitHub Create OAuth App](/img/integrations/github-create-oauth-app.png)
5259

53-
Once the OAuth App has been created, click on **Generate a new client secret** under the 'Client secrets' section and copy the secret as it will be visible once only
60+
Once the OAuth App has been created, click on **Generate a new client secret**
61+
under the 'Client secrets' section and copy the secret as it will be visible
62+
once only
5463

5564
Keep the following details handy:
5665

@@ -61,10 +70,13 @@ Keep the following details handy:
6170

6271
### **Step 3: GitHub App**
6372

64-
Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the 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):
73+
Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the
74+
steps below to
75+
[create a GitHub App](https://docs.github.com/en/enterprise-server@latest/apps/creating-github-apps/registering-a-github-app/registering-a-github-app):
6576

6677
1. Sign in to your GitHub Enterprise account.
67-
2. In the upper-right corner of any page, click your profile photo, then click **Settings**.
78+
2. In the upper-right corner of any page, click your profile photo, then click
79+
**Settings**.
6880
3. In the left sidebar, click **Developer settings** > **GitHub Apps**
6981
4. Click **New GitHub App**.
7082
5. Set the following fields:
@@ -100,9 +112,12 @@ Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the
100112
- Release
101113
6. Click **Create GitHub App**.
102114

103-
Once the GitHub App has been created, click on **Generate a new client secret** under the 'Client secrets' section and copy the secret as it will be visible once only.
115+
Once the GitHub App has been created, click on **Generate a new client secret**
116+
under the 'Client secrets' section and copy the secret as it will be visible
117+
once only.
104118

105-
Scroll down and click on **Generate a private key** under the 'Private keys' section and download the PEM file.
119+
Scroll down and click on **Generate a private key** under the 'Private keys'
120+
section and download the PEM file.
106121

107122
Keep the following details handy:
108123

@@ -127,18 +142,21 @@ Submit the details that were accumulated in previous steps:
127142
- GitHub App Webhook Secret
128143
- GitHub App Private Key
129144

130-
Click on Submit and the login process will be initiated.
131-
On subsequent visits, your setup will be automatically detected, allowing for direct login.
145+
Click on Submit and the login process will be initiated. On subsequent visits,
146+
your setup will be automatically detected, allowing for direct login.
132147

133148
### **Step 5: Install the GitHub App**
134149

135-
Navigate to the GitHub App that was created from your Github Enterprise Server (self-hosted) instance and click on the **Install App** tab.
136-
Then, install the GitHub App to your organization(s).
150+
Navigate to the GitHub App that was created from your GitHub Enterprise Server
151+
(self-hosted) instance and click on the **Install App** tab. Then, install the
152+
GitHub App to your organization(s).
137153

138154
:::warning
139155

140-
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.
141-
Navigate to the **Advanced** tab in the GitHub App and click on the **Redeliver** button for the failed `installation.created` event.
156+
If you performed this step before Step 4, the installation event likely will
157+
have failed, and you will need to re-send the installation event.
158+
Navigate to the **Advanced** tab in the GitHub App and click on the
159+
**Redeliver** button for the failed `installation.created` event.
142160

143161
:::
144162

docs/tools/actionlint.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ sidebar_label: Actionlint
44
description: CodeRabbit's guide to Actionlint.
55
---
66

7-
[Actionlint](https://github.com/rhysd/actionlint/) is a static checker for GitHub Actions workflow files.
7+
[Actionlint](https://github.com/rhysd/actionlint/) is a static checker for
8+
GitHub Actions workflow files.
89

910
## Files
1011

11-
We look for `Github Action` files specifically in the following directory:
12+
We look for `GitHub Action` files specifically in the following directory:
1213

1314
- `.github/workflows/**/*.yml`
1415
- `.github/workflows/**/*.yaml"`

0 commit comments

Comments
 (0)