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.mdx
+49-20Lines changed: 49 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,29 @@
1
1
---
2
2
title: GitHub
3
3
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.
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
-
18
16
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.
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
25
27
26
28
To get started, you'll need to connect your GitHub account, organization, and repositories with Plane. Follow the steps below to complete the setup:
27
29
@@ -30,19 +32,46 @@ To get started, you'll need to connect your GitHub account, organization, and re
Link your GitHub organization to your Plane workspace to start syncing repositories.
33
36
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.
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
+
:::
37
42
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**.
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**.
0 commit comments