Skip to content

Commit 7da56bd

Browse files
committed
review fixes
1 parent 3211ff3 commit 7da56bd

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

docs/integrations/github.mdx

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,31 @@ Once GitHub is connected to Plane, workspace admins can link GitHub repositories
140140

141141
All configured project issue syncs will appear in a list where you can edit or remove them as needed.
142142

143+
### Sync issues to Plane
144+
After configuring project work item sync, you can link existing GitHub issues into your Plane project.
145+
146+
#### GitHub → Plane
147+
148+
1. In your GitHub repository, add the `Plane` label to any issue you want to sync.
149+
![Add Plane label](https://media.docs.plane.so/integrations/github/add-plane-label.webp#center)
150+
2. The issue will automatically be created as a work item in the linked Plane project.
151+
3. Plane posts a comment on the GitHub issue with a link to the newly created work item, confirming the connection.
152+
![Synced issue from GitHub](https://media.docs.plane.so/integrations/github/synced-issue-from-github.webp#center)
153+
4. The work item in Plane will include a link back to the original GitHub issue.
154+
![Creates issue in Plane](https://media.docs.plane.so/integrations/github/creates-plane-issue.webp#center)
155+
156+
### Sync work items to GitHub
157+
If you have existing work items in Plane that you want to sync to GitHub, you can do so using labels.
158+
159+
#### Plane → GitHub
160+
161+
1. In your Plane project, add the `GitHub` label to any work item you want to sync.
162+
![Add GitHub label](https://media.docs.plane.so/integrations/github/add-github-label.webp#center)
163+
2. A new issue will automatically be created in the linked GitHub repository.
164+
![Creates issue in GitHub](https://media.docs.plane.so/integrations/github/create-github-issue.webp#center)
165+
3. The GitHub issue will be linked back to the Plane work item.
166+
4. Future updates will sync according to your configured sync direction (unidirectional or bidirectional).
167+
143168
### How issue syncing works
144169

145170
#### State synchronization
@@ -176,7 +201,7 @@ Here’s what syncs automatically between Plane and GitHub:
176201
| Mentions | Both ways | Mentioned users sync if they are mapped; otherwise, a GitHub profile link is included. |
177202
| Issue links | GitHub → Plane | Any issue references in GitHub descriptions or comments will be displayed in Plane with a direct link to the issue including the repository name and owner. |
178203

179-
## Sync pull requests
204+
## Configure PR state automation
180205

181206
Pull requests (PRs) are also synchronized with Plane to ensure work item tracking remains accurate throughout the development lifecycle.
182207

0 commit comments

Comments
 (0)