Skip to content

Commit fe8ff4f

Browse files
committed
minor fixes
1 parent 657724b commit fe8ff4f

1 file changed

Lines changed: 16 additions & 28 deletions

File tree

docs/integrations/github.md

Lines changed: 16 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ GitHub integration with Plane allows seamless synchronization between your GitHu
1010
Plane supports integration with:
1111

1212
- **GitHub Cloud** (github.com)
13-
The standard GitHub service, available at github.com. Covers all account types
13+
The standard GitHub service, available at github.com. Covers all plans
1414

1515
- **GitHub Enterprise Cloud** (ghe.com)
1616
GitHub's managed enterprise service where your organization gets a dedicated subdomain
@@ -19,7 +19,7 @@ Plane supports integration with:
1919
A self-hosted GitHub instance deployed on your own infrastructure
2020

2121
:::tip
22-
GitHub Cloud has its own integration page in Plane's settings. GitHub Enterprise Cloud (GHE.com) and GitHub Enterprise Server share the same page a toggle at the top of the configuration form switches between the two.
22+
GitHub Cloud has its own integration page in Plane's settings. GitHub Enterprise Cloud (GHE.com) and GitHub Enterprise Server share the same page - a toggle at the top of the configuration form switches between the two.
2323
:::
2424

2525
## What the integration does
@@ -61,7 +61,7 @@ Link your GitHub organization to your Plane workspace to start syncing repositor
6161
> [!CAUTION] Plane self-hosted instances
6262
> If you're running a self-hosted instance of Plane, you'll need to first create and configure a GitHub App to get GitHub integration working. Follow this [setup guide](https://developers.plane.so/self-hosting/govern/integrations/github?edition=github-cloud#create-github-app) first before diving into the steps on this page.
6363
64-
![Connect GitHub Cloud](https://media.docs.plane.so/integrations/github/connect-github-cloud.webp#hero)
64+
![Connect GitHub Cloud](https://media.docs.plane.so/integrations/github/github-cloud.webp#hero)
6565

6666
1. Go to **Settings → Integrations → GitHub** in your Plane workspace.
6767
2. Click **Connect**.
@@ -74,12 +74,14 @@ The integration page shows the connected organization name and avatar. Plane has
7474

7575
== GitHub Enterprise Cloud {#ghe-cloud}
7676

77+
GitHub Enterprise Cloud (GHE.com) organizations have a dedicated subdomain (`<your-org>.ghe.com`). This is a distinct setup from GitHub Cloud - you create your own GitHub App on your GHE.com organization and provide Plane with its credentials.
78+
7779
> [!CAUTION] Plane Cloud and self-hosted instances
78-
> This integration is currently only available on Plane Cloud. Support for the Commercial Edition is coming soon.
80+
> Before you can integrate with GitHub Enterprise Cloud, you must first create and configure a GitHub App. This is required for both Plane Cloud and self-hosted users.
7981
>
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.
82+
> Follow this [setup guide](https://developers.plane.so/self-hosting/govern/integrations/github?edition=github-enterprise#create-github-app) first before diving into the steps on this section.
8183
82-
![Connect GitHub Enerprise Cloud](https://media.docs.plane.so/integrations/github/connect-github-enterprise.webp#hero)
84+
![Connect GitHub Enerprise Cloud](https://media.docs.plane.so/integrations/github/github-enterprise-server.webp#hero)
8385

8486
1. Go to **Settings → Integrations → GitHub Enterprise** in your Plane workspace.
8587
2. Click **Connect**.
@@ -90,7 +92,7 @@ The integration page shows the connected organization name and avatar. Plane has
9092
The numeric identifier for your GitHub App. Find it on your GHE.com GitHub App settings page under **App ID**.
9193

9294
**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/`
95+
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/`
9496
Example: `my-plane-app`
9597

9698
**Enterprise slug**
@@ -104,10 +106,10 @@ The integration page shows the connected organization name and avatar. Plane has
104106
The OAuth client identifier for your GitHub App. Find it on your GHE.com GitHub App settings page under **Client ID**.
105107

106108
**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.
109+
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.
108110

109111
**Webhook secret**
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.
112+
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.
111113

112114
**Private key**
113115
The base64-encoded contents of the `.pem` private key file you downloaded from your GHE.com GitHub App settings. To encode it, run `base64 -i your-key.pem` and paste the full output.
@@ -124,7 +126,7 @@ Plane stores these credentials tied to your workspace and uses them to authentic
124126
>
125127
> Follow this [setup guide](https://developers.plane.so/self-hosting/govern/integrations/github?edition=github-enterprise#create-github-app) first before diving into the steps on this section.
126128
127-
![Connect GitHub Enerprise Server](https://media.docs.plane.so/integrations/github/connect-github-enterprise.webp#hero)
129+
![Connect GitHub Enerprise Server](https://media.docs.plane.so/integrations/github/github-enterprise-server.webp#hero)
128130

129131
1. Go to **Settings → Integrations → GitHub Enterprise Server** in your Plane workspace.
130132
2. Click **Connect**.
@@ -145,10 +147,10 @@ Plane stores these credentials tied to your workspace and uses them to authentic
145147
The OAuth client identifier for your GitHub App. Find it on your GHES GitHub App settings page under **Client ID**.
146148

147149
**Client Secret**
148-
The OAuth client secret generated from your GHES GitHub App settings. It is shown only once when generated use the value you copied at that time.
150+
The OAuth client secret generated from your GHES GitHub App settings. It is shown only once when generated - use the value you copied at that time.
149151

150152
**Webhook Secret**
151-
The secret string you set when creating the GitHub App on GHES. Must match exactly what is configured on the app Plane uses it to verify incoming webhook signatures.
153+
The secret string you set when creating the GitHub App on GHES. Must match exactly what is configured on the app - Plane uses it to verify incoming webhook signatures.
152154

153155
**Private Key**
154156
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.
@@ -170,7 +172,7 @@ When this connection is enabled, comments made in Plane will appear in GitHub un
170172

171173
Workspace admins can connect their personal GitHub accounts from the GitHub configuration page.
172174

173-
![Connect personal account](https://media.docs.plane.so/integrations/github/connect-personal-account.webp#hero)
175+
![Connect personal account](https://media.docs.plane.so/integrations/github/connect-personal-account-admin.webp#hero)
174176

175177
1. In the **Connect personal account** section under **Integrations**, click **Connect**.
176178
2. Review the required permissions GitHub requests and authorize.
@@ -183,7 +185,7 @@ Only one Workspace Admin can connect their GitHub account via Workspace Settings
183185
All other workspace members can connect their personal GitHub accounts from the **Connections** page in
184186
Workspace settings.
185187

186-
![Connect member personal account](https://media.docs.plane.so/integrations/github/connect-personal-account-member.webp#hero)
188+
![Connect member personal account](https://media.docs.plane.so/integrations/github/connect-personal-account-members.webp#hero)
187189

188190
1. Go to [Workspace Settings](/core-concepts/workspaces/overview#access-workspace-settings).
189191
2. Select the **Connections** tab in the sidebar.
@@ -236,32 +238,18 @@ After configuring project work item sync, you can link existing GitHub issues in
236238
#### GitHub → Plane
237239

238240
1. In your GitHub repository, add the `Plane` label to any issue you want to sync.
239-
240-
![Add Plane label](https://media.docs.plane.so/integrations/github/add-plane-label.webp#hero)
241-
242241
2. The issue will automatically be created as a work item in the linked Plane project.
243242
3. Plane posts a comment on the GitHub issue with a link to the newly created work item, confirming the connection.
244-
245-
![Synced issue from GitHub](https://media.docs.plane.so/integrations/github/synced-issue-from-github.webp#hero)
246-
247243
4. The work item in Plane will include a link back to the original GitHub issue.
248244

249-
![Creates issue in Plane](https://media.docs.plane.so/integrations/github/creates-plane-issue.webp#hero)
250-
251245
### Sync work items to GitHub
252246

253247
If you have existing work items in Plane that you want to sync to GitHub, you can do so using labels.
254248

255249
#### Plane → GitHub
256250

257251
1. In your Plane project, add the `GitHub` label to any work item you want to sync.
258-
259-
![Add GitHub label](https://media.docs.plane.so/integrations/github/add-github-label.webp#hero)
260-
261252
2. A new issue will automatically be created in the linked GitHub repository.
262-
263-
![Creates issue in GitHub](https://media.docs.plane.so/integrations/github/create-github-issue.webp#hero)
264-
265253
3. The GitHub issue will be linked back to the Plane work item.
266254
4. Future updates will sync according to your configured sync direction (unidirectional or bidirectional).
267255

0 commit comments

Comments
 (0)