You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/integrations/github.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ GitHub integration with Plane allows seamless synchronization between your GitHu
9
9
10
10
Plane supports integration with:
11
11
12
-
-**GitHub Cloud** (github.com)
12
+
-**GitHub Cloud** (github.com)
13
13
The standard GitHub service, available at github.com. Covers all account types
14
14
15
15
-**GitHub Enterprise Cloud** (ghe.com)
@@ -76,35 +76,35 @@ The integration page shows the connected organization name and avatar. Plane has
76
76
77
77
> [!CAUTION] Plane Cloud and self-hosted instances
78
78
> This integration is currently only available on Plane Cloud. Support for the Commercial Edition is coming soon.
79
-
>
79
+
>
80
80
> Before you can integrate with GitHub Enterprise Cloud (GHE.com) , you must first create and configure a GitHub App in your GitHub Enterprise Server instance. This is required for both Plane Cloud and self-hosted users. Follow this [setup guide](https://developers.plane.so/self-hosting/govern/integrations/github?edition=github-enterprise-cloud#create-github-app) first before diving into the steps on this page.
1. Go to **Settings → Integrations → GitHub Enterprise** in your Plane workspace.
85
85
2. Click **Connect**.
86
86
3. At the top of the configuration form, enable the **GitHub Enterprise Cloud (ghe.com)** toggle.
87
87
4. Fill in the form.
88
-
88
+
89
89
**App ID**
90
-
The numeric identifier for your GitHub App. Find it on your GHE.com GitHub App settings page under **App ID**.
90
+
The numeric identifier for your GitHub App. Find it on your GHE.com GitHub App settings page under **App ID**.
91
91
92
92
**App slug**
93
-
The URL-safe name assigned to your app, visible in the app's GitHub URL. Find it in the URL when viewing your app settings — the segment after `/apps/`
93
+
The URL-safe name assigned to your app, visible in the app's GitHub URL. Find it in the URL when viewing your app settings — the segment after `/apps/`
94
94
Example: `my-plane-app`
95
95
96
96
**Enterprise slug**
97
97
The subdomain prefix of your GHE.com organization. This is the part before `.ghe.com` in your organization's URL.
98
98
Example: `acme` from `acme.ghe.com`
99
99
100
100
**Organisation ID**
101
-
The numeric ID of your GHE.com organization. Retrieve it from the [GitHub REST API](https://docs.github.com/en/rest/orgs/orgs?apiVersion=2026-03-10#get-an-organization): send `GET https://api.github.com/orgs/<org-name>` and use the `id` field from the response.
101
+
The numeric ID of your GHE.com organization. Retrieve it from the [GitHub REST API](https://docs.github.com/en/rest/orgs/orgs?apiVersion=2026-03-10#get-an-organization): send `GET https://api.github.com/orgs/<org-name>` and use the `id` field from the response.
102
102
103
103
**Client ID**
104
-
The OAuth client identifier for your GitHub App. Find it on your GHE.com GitHub App settings page under **Client ID**.
104
+
The OAuth client identifier for your GitHub App. Find it on your GHE.com GitHub App settings page under **Client ID**.
105
105
106
106
**Client secret**
107
-
The OAuth client secret generated from your GHE.com GitHub App settings. It is shown only once when generated — use the value you copied at that time.
107
+
The OAuth client secret generated from your GHE.com GitHub App settings. It is shown only once when generated — use the value you copied at that time.
108
108
109
109
**Webhook secret**
110
110
The secret string you set when creating the GitHub App on GHE.com. Must match exactly what is configured on the app — Plane uses it to verify incoming webhook signatures.
@@ -154,7 +154,7 @@ Plane stores these credentials tied to your workspace and uses them to authentic
154
154
The contents of the `.pem` private key file you downloaded from your GHES GitHub App settings. Paste the full PEM content including the `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----` lines.
155
155
156
156
4. Click **Connect app**. You are redirected to your GHES instance.
157
-
5. Select the organization to install on and authorize.
157
+
5. Select the organization to install on and authorize.
158
158
6. Select whether you want to sync all repositories or pick specific ones.
159
159
7. Click **Install** to finalize the connection.
160
160
8. After authorization, you'll be redirected back to Plane, where your GitHub organization will appear as connected.
0 commit comments