Skip to content

Commit 774f0d3

Browse files
authored
Merge pull request #339 from makeplane/chore-add_github_enterprise_page
[DOCSW-442] Github Enterprise Integration Docs
2 parents ecca9e0 + 43c2ab7 commit 774f0d3

File tree

2 files changed

+52
-20
lines changed

2 files changed

+52
-20
lines changed

docs/integrations/about.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ Plane's integrations make it easy to connect your workspace and projects with yo
1111
<Card title="Github" icon="FaGithub" href="/integrations/github">
1212
Sync issues and pull requests between Plane and GitHub for a smooth, two-way workflow.
1313
</Card>
14+
<Card title="GitHub Enterprise" icon="FaGithub" href="/integrations/github?edition=github-enterprise#connect-github-organization">
15+
Sync issues and pull requests between Plane and GitHub Enterprise for a smooth, two-way workflow.
16+
</Card>
1417
<Card title="Slack" icon="FaSlack" href="/integrations/slack">
1518
Connect Plane with Slack to create work items, sync discussions, and take action on tasks—all without leaving Slack.
1619
</Card>

docs/integrations/github.mdx

Lines changed: 49 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
11
---
22
title: GitHub
33
hide_title: true
4-
description: Integrate Plane with GitHub to synchronize issues and pull requests. Connect repositories to projects for bidirectional updates and seamless workflows.
4+
description: Integrate Plane with GitHub Cloud and GitHub Enterprise Server to synchronize issues and pull requests. Connect repositories to projects for bidirectional updates and seamless workflows.
55
---
66

77
import Tags from "@site/src/components/Tags";
8+
import Tabs from '@theme/Tabs';
9+
import TabItem from '@theme/TabItem';
810

911
<div className="tag-wrapper">
1012
<h1>Integrate with GitHub</h1>
1113
<Tags tags={[{ name: "Pro", link: "https://plane.so/pricing", additionalClass: "pro" }]} />
1214
</div>
1315

14-
:::note[Self-hosted GitHub instance]
15-
At the moment, we only support GitHub Cloud for integrations. Support for self-hosted GitHub instances (GitHub Enterprise Server) isn’t available just yet—but we’re actively working on it.
16-
:::
17-
1816
GitHub integration with Plane allows seamless synchronization between your GitHub repositories and Plane projects. By linking the two, your issues and pull requests stay updated across both platforms, enhancing collaboration and streamlining your workflow. Whether you're managing code, tasks, or both, this integration ensures your team stays in sync without the hassle of switching between platforms.
1917

20-
## Set up GitHub integration
18+
Plane supports integration with:
2119

22-
:::danger[Self-hosted Plane instance (Commercial Edition)]
23-
If you're running a self-hosted instance of Plane, you'll need to set up a few extra configurations to get GitHub integration working. Check out the [setup guide](https://developers.plane.so/self-hosting/govern/integrations/github) first before diving into the steps on this page.
24-
:::
20+
- **GitHub Cloud**.
21+
The standard cloud-hosted GitHub service
22+
23+
- **GitHub Enterprise Server**.
24+
Self-hosted GitHub instances for organizations with specific compliance or security requirements
25+
26+
## Set up GitHub integration
2527

2628
To get started, you'll need to connect your GitHub account, organization, and repositories with Plane. Follow the steps below to complete the setup:
2729

@@ -30,19 +32,46 @@ To get started, you'll need to connect your GitHub account, organization, and re
3032
3. [Add repository mappings](/integrations/github#add-repository-mappings)
3133

3234
### Connect GitHub organization
35+
Link your GitHub organization to your Plane workspace to start syncing repositories.
3336

34-
Link your GitHub organization to your Plane workspace to start syncing repositories. This step is crucial for enabling the full range of GitHub-Plane integrations.
35-
36-
![Connect GitHub](https://media.docs.plane.so/integrations/github/connect-github.webp#center)
37+
<Tabs queryString="edition">
38+
<TabItem value="github-cloud" label="GitHub Cloud">
39+
:::danger[Plane self-hosted instances]
40+
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.
41+
:::
3742

38-
1. Navigate to [Workspace settings](/core-concepts/workspaces/overview#workspace-settings) in Plane.
39-
2. On the right pane, select **Integrations**.
40-
3. Find the **GitHub** integration and click **Configure**.
41-
4. In the **Connect Organization** section, click **Connect**.
42-
5. On the GitHub app installation page, choose the organization you want to connect.
43-
6. Select whether you want to sync all repositories or pick specific ones.
44-
7. Click **Install** to finalize the connection.
45-
8. After authorization, you’ll be redirected back to Plane, where your GitHub organization will appear as connected.
43+
1. Navigate to [Workspace settings](/core-concepts/workspaces/overview#workspace-settings) in Plane.
44+
2. On the right pane, select **Integrations**.
45+
3. Find the **GitHub** integration and click **Configure**.
46+
4. In the **Connect Organization** section, click **Connect**.
47+
![Connect GitHub](https://media.docs.plane.so/integrations/github/connect-github.webp#center)
48+
5. On the GitHub app installation page, choose the organization you want to connect.
49+
6. Select whether you want to sync all repositories or pick specific ones.
50+
7. Click **Install** to finalize the connection.
51+
8. After authorization, you’ll be redirected back to Plane, where your GitHub organization will appear as connected.
52+
</TabItem>
53+
54+
<TabItem value="github-enterprise" label="GitHub Enterprise Server">
55+
:::danger[Plane Cloud and self-hosted instances]
56+
57+
Before you can integrate with GitHub Enterprise Server, 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.
58+
59+
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.
60+
:::
61+
62+
1. Navigate to [Workspace settings](/core-concepts/workspaces/overview#workspace-settings) in Plane.
63+
2. On the right pane, select **Integrations**.
64+
3. Find the **GitHub Enterprise** integration and click **Configure**.
65+
4. In the **Connect Organization** section, click **Connect**.
66+
![Connect GitHub Enterprise organization](https://media.docs.plane.so/integrations/github/connect-github-enterprise.webp#center)
67+
5. Fill the form with the details of your GitHub Enterprise instance and click **Connect**.
68+
![Configure GitHub Enterprise organization](https://media.docs.plane.so/integrations/github/configure-github-enterprise.webp#center)
69+
6. On the GitHub app installation page, choose the organization you want to connect.
70+
7. Select whether you want to sync all repositories or pick specific ones.
71+
8. Click **Install** to finalize the connection.
72+
9. After authorization, you’ll be redirected back to Plane, where your GitHub organization will appear as connected.
73+
</TabItem>
74+
</Tabs>
4675

4776
### Connect personal GitHub account
4877

0 commit comments

Comments
 (0)