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
+90-43Lines changed: 90 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -108,46 +108,61 @@ If you don’t have admin access, you can still connect your personal GitHub acc
108
108
:::
109
109
5. Once connected, your GitHub account will be listed in Plane.
110
110
111
-
### Add repository mappings
111
+
##Sync issues
112
112
113
-
Once GitHub is connected to Plane, workspace admins can map GitHub repositories to Plane projects. This ensures issues and pull requests sync correctly.
113
+
With the GitHub integration set up, you can sync issues between Plane and GitHub at the project level. This ensures GitHub issues and Plane work items stay synchronized within your configured repositories and projects.
All configured project issue syncs will appear in a list where you can edit or remove them as needed.
142
+
143
+
### How issue syncing works
144
+
145
+
#### State synchronization
129
146
130
-
With the GitHub integration setup, you can start syncing issues between Plane and GitHub. The synchronization is bi-directional and label-based, so issues are updated automatically on both platforms when certain labels are applied.
147
+
- When a GitHub issue is opened or closed, the corresponding Plane work item automatically moves to the mapped state.
148
+
- With bidirectional sync enabled, state changes in Plane work items will also update the GitHub issue status (open/closed).
131
149
132
-
###Github -> Plane
150
+
#### Creating synced issues
133
151
134
-
1. Add the `Plane` label to an issue in GitHub to create and sync the issue in Plane.

147
-
3. The GitHub issue is also linked back to Plane.
157
+
- All synced properties (title, description, assignees, labels, comments, etc.) update automatically based on your sync direction settings.
158
+
- See [What gets synced?](#what-gets-synced) for detailed information on property-level sync behavior
148
159
149
160
### What gets synced?
150
161
162
+
:::warning[important]
163
+
By default, syncing is unidirectional (GitHub → Plane only). Data from GitHub issues will overwrite corresponding data in Plane. Changes made in Plane will not sync back to GitHub unless you enable Bidirectional sync in your integration settings.
164
+
:::
165
+
151
166
Here’s what syncs automatically between Plane and GitHub:
@@ -163,27 +178,59 @@ Here’s what syncs automatically between Plane and GitHub:
163
178
164
179
## Sync pull requests
165
180
166
-
Pull requests (PRs) are also synchronized with Plane to ensure issue tracking remains accurate throughout the development lifecycle.
181
+
Pull requests (PRs) are also synchronized with Plane to ensure work item tracking remains accurate throughout the development lifecycle.
182
+
183
+
### Add pull request mapping
184
+
185
+
Once GitHub is connected to Plane, workspace admins can configure pull request state mapping for Plane projects. This ensures PR states automatically sync with work item states in the mapped project.
186
+
187
+
1. Navigate to the **Pull request state mapping** section.
3. In the modal that appears, configure the following:
191
+
-**Plane project**
192
+
Select the Plane project where PR state automation should be enabled.
193
+
-**Pull request automation**
194
+
Map GitHub pull request states to Plane work item states
195
+

196
+
4. Click **Save**.
197
+
198
+
All configured pull request state mappings will appear in a list where you can edit or remove them as needed.
199
+
200
+
### Set up PR automation
201
+
202
+
To automate pull request state changes with Plane work items:
203
+
204
+
1. Configure PR state mapping for your Plane project to enable PR state automation. See [Add pull request mapping](#add-pull-request-mapping).
205
+
2. Reference Plane work items in your GitHub PR title or description using the appropriate format. See [Reference formats](#reference-formats) below.
206
+
3. Automatic state updates will move the work item state in Plane based on the GitHub PR state defined in your mapping.
207
+
208
+
#### Reference formats
209
+
There are two ways to reference Plane work items in your GitHub PRs:
167
210
168
-
####Closing references and auto-updates
211
+
##### With brackets [WEB-344] - State automation
169
212
170
-
When a pull request includes closing references to GitHub issues (e.g., `closes #14`), any linked Plane work items will automatically update with the PR link. If the PR is merged or closed, the Plane work item state updates based on the configured workflow in [Repository mappings](/integrations/github#add-repository-mappings).
213
+
- Links the work item to the PR
214
+
- Adds a comment from Plane App showing linked work items
215
+
- Automatically updates the work item state based on PR state changes (as configured in your PR state mapping)
171
216
172
-
####Magic words for issue references
217
+
##### Without brackets WEB-344 - Link only
173
218
174
-
You can use specific keywords in GitHub pull requests to manage how Plane work items are updated.
219
+
- Links the work item to the PR as a reference
220
+
- Adds a comment from Plane App showing referenced work items
221
+
- Does not trigger automatic state updates
175
222
176
-
-**Closing references**
177
-
These keywords close linked issues when the PR is merged or closed.
- WEB-344 will be fully automated (state changes with PR state)
231
+
- WEB-345 will be linked as a reference only (no state automation)
185
232
186
-
####PR lifecycle mapping
233
+
### PR lifecycle mapping
187
234
188
235
The lifecycle of a pull request can be [mapped](/integrations/github#add-repository-mappings) to workflow states in Plane. The following PR states are available for mapping:
189
236
@@ -194,9 +241,9 @@ The lifecycle of a pull request can be [mapped](/integrations/github#add-reposit
194
241
- The PR is successfully merged.
195
242
- The PR is closed without merging.
196
243
197
-
####Issue backlinks in pull requests
244
+
### Issue backlinks in pull requests
198
245
199
-
When a PR references Plane work items (using closing or non-closing reference keywords), Plane will post a confirmation comment on the pull request, ensuring visibility into which issues are linked.
246
+
When a PR references Plane work items, Plane will post a confirmation comment on the pull request, ensuring visibility into which issues are linked.
0 commit comments