Skip to content

Commit 8062f49

Browse files
committed
add images
1 parent 728a66c commit 8062f49

File tree

10 files changed

+30
-17
lines changed

10 files changed

+30
-17
lines changed
56.4 KB
Loading
20.1 KB
Loading
21.3 KB
Loading
31.1 KB
Loading
66 KB
Loading
75.3 KB
Loading
18 KB
Loading
44.7 KB
Loading
50.7 KB
Loading

self-hosting/govern/integrations/github.mdx

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,10 @@ To configure GitHub integration, you'll need to create a GitHub App within your
2323
1. Go to **Settings \> Developer Settings \> GitHub Apps** in your GitHub organization.
2424

2525
2. Click **New GitHub App**.
26+
![Create GitHub App](/images/github-integration/create-github-app.webp)
2627

27-
3. Provide a **GitHub App name** and **Homepage URL**.
28+
3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**.
29+
![App name and homepage URL](/images/github-integration/app-name-homepage-url.webp)
2830

2931
4. In the **Identifying and authorizing users** section, add the following **Callback URLS**.
3032

@@ -33,14 +35,15 @@ To configure GitHub integration, you'll need to create a GitHub App within your
3335
https://<your-domain>/silo/api/github/auth/user/callback
3436
```
3537
These URLs allow Plane to verify and enable workspace connection with the Github App.
38+
![Add Callback URL](/images/github-integration/add-callback-url.webp)
3639

3740
5. In the **Post installation** section, add the below **Setup URL**.
3841

3942
```bash
4043
https://<your-domain>/silo/api/github/auth/callback
4144
```
4245
Redirects users to this URL after GitHub app installation.
43-
46+
![Add setup URL](/images/github-integration/add-setup-url.webp)
4447

4548
6. Turn on **Redirect on update**.
4649

@@ -50,29 +53,35 @@ To configure GitHub integration, you'll need to create a GitHub App within your
5053
```
5154
This allows Plane to receive updates from GitHub repositories.
5255

56+
![Add Webhook URL](/images/github-integration/add-webhook-url.webp)
57+
5358
### Set up permissions and events
5459

5560
1. Add repository and account permissions by setting the **Access** dropdown next to each permission, as shown in the tables below.
61+
![Setup permissions](/images/github-integration/setup-permissions.webp)
5662

5763
**Repository permissions**
5864

59-
|Permission|Access level|Purpose|
60-
|---------|------------|-----------|
61-
|Commit statuses|Read-only|Monitor CI/CD status of commits|
62-
|Contents|Read and write|Read and modify repository files|
63-
|Issues|Read and write|Sync issues between Plane and GitHub|
64-
|Merge queues|Read-only|View merge queue details|
65-
|Metadata|Read-only|Access repository details|
66-
|Pull requests|Read and write|Manage pull requests|
65+
|Permission&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|Access&nbsp;level&nbsp;&nbsp;&nbsp;&nbsp;|Purpose|
66+
|---------|---------------------|-----------|
67+
|Commit statuses|Read-only|Allows the GitHub app to read and update commit statuses, indicating whether a commit has passed checks (e.g., CI/CD pipelines).|
68+
|Contents|Read and write|Grants access to read and modify repository contents, including reading files, creating commits, and updating files.|
69+
|Issues|Read and write|Enables reading, creating, updating, closing, and commenting on issues within the repository.|
70+
|Merge queues|Read-only|Allows interaction with merge queues to manage the order of pull request merges.|
71+
|Metadata|Read-only|Provides read-only access to repository metadata, such as its name, description, and visibility.|
72+
|Pull requests|Read and write|Allows reading, creating, updating, merging, and commenting on pull requests.|
6773

6874
**Account permissions**
6975

70-
|Permission|Access level|Purpose|
76+
|Permission&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|Access&nbsp;level&nbsp;&nbsp;&nbsp;&nbsp;|Purpose|
7177
|---------|------------|-----------|
72-
|Email addresses|Read-only|Access user email for notifications|
73-
|Profile|Read and write|Retrieve and update user profile data|
78+
|Email addresses|Read-only|Grants access to users' email addresses, typically for notifications or communication.|
79+
|Profile|Read and write|Enables access to user profile details like name, username, and avatar.|
80+
7481

7582
2. In the **Subscribe to events** section, turn on all the required events below.
83+
84+
![Subscribe to events](/images/github-integration/subscribe-to-events.webp)
7685

7786
|Event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|Purpose|
7887
|---------|------------|
@@ -87,7 +96,7 @@ To configure GitHub integration, you'll need to create a GitHub App within your
8796
|Push|Activates when new commits are pushed to a repository. Useful for tracking code updates and changes.|
8897
|Rsepository sub issues|Tracks issues within a repository that are linked to or managed by another issue. Ensures accurate synchronization of related issues.|
8998

90-
3. Click the **Create Github App** button.
99+
3. Click the **Create GitHub App** button at the bottom of the page.
91100

92101
## Configure Plane instance
93102

@@ -97,18 +106,22 @@ To configure GitHub integration, you'll need to create a GitHub App within your
97106

98107
3. In the **General** tab, under the **Client secrets** section, click **Generate a new client secret**.
99108

109+
![General tab](/images/github-integration/general-tab.webp)
110+
100111
4. Scroll down to the **Private keys** section.
101112

113+
![Private keys](/images/github-integration/private-keys.webp)
114+
102115
5. Click **Genereate a private key**.
103116

104-
6. Retrieve the following details from the General tab:
117+
6. Retrieve the following details from the **General** tab:
105118
- App ID
106119
- Client ID
107120
- Client secret
108121
- GitHub App name
109122
- Private key
110123

111-
7. Add these environment variables to your Plane instance's `.env` file.
124+
7. Add these environment variables with the values to your Plane instance's `.env` file.
112125

113126
```bash
114127
GITHUB_CLIENT_ID=<CLIENT_ID>
@@ -118,6 +131,6 @@ To configure GitHub integration, you'll need to create a GitHub App within your
118131
GITHUB_PRIVATE_KEY=<PRIVATE_KEY>
119132
```
120133

121-
8. Save the file and restrat the instance.
134+
8. Save the file and restart the instance.
122135

123136
9. Once you've completed the instance configuration, [activate the GitHub integration in Plane](https://docs.plane.so/integrations/github).

0 commit comments

Comments
 (0)