makeplane / makeplane/developer-docs
Outbound Plane→GitHub sync requires hardcoded "github" label , undocumented
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- JavaScript
- Star
- 16
- Fork
- 23
- Merge trung bình
- 46 phút
- Pull request đã merge (30 ngày)
- 1
Mô tả
Summary:
After completing the GitHub App setup, configuring the workspace connection, connecting a personal account, and enabling Project Issue Sync with "bidirectional" turned on, Plane work items created in the UI still do not sync to GitHub.
Investigation of silo's compiled source at /app/apps/silo/dist/start.mjs (around line 31738 in the v2.3.0 bundle) reveals:
if (!labels || !labels.find((label) => label.name.toLowerCase() === E_INTEGRATION_KEYS.GITHUB.toLowerCase())) return res.status(202).send({ message: "Webhook received" });
Silo requires the Plane work item to have a label named literally github (case-insensitive). Work items without this label receive a 202 response and are silently dropped — no error, no log beyond the initial receipt.
The label name is hardcoded to the E_INTEGRATION_KEYS.GITHUB constant and is not configurable per-project, per-workspace, or via environment variable.
Impact:
This undocumented requirement was the final blocker after roughly 14 hours of debugging the same installation. I reached the Plane support draft stage before finding this in source. The "What gets synced?" documentation page describes Labels as a property that flows bidirectionally between systems ("If a Label doesn't exist in Plane, it will be created (and vice versa)") — which strongly implies any label flows, not that one specific label name acts as a sync gate.
The mismatch between UI promise and actual behavior is significant:
UI: "Project Issue Sync" configured with "bidirectional" enabled
Docs: "Issues created in GitHub are automatically created in the linked Plane project. With bidirectional sync enabled, work items created in Plane are also created in GitHub."
Reality: Plane→GitHub works only if the work item has a specific hardcoded label
Proposed documentation change:
On the GitHub integration "how it works" page, add a prominent note:
Outbound sync requires the github label
Work items created in Plane only sync to GitHub if they have a label named github (case-insensitive). This acts as an opt-in mechanism to prevent every Plane work item from being automatically published to GitHub. Work items without this label will remain Plane-only even when bidirectional sync is enabled.
Create the github label in your project's Labels settings, then apply it to any work item you want mirrored to GitHub. All other labels on the work item will propagate normally to GitHub during sync.
Feature request / secondary suggestion:
Consider making the gate label configurable per-project. Teams using existing label taxonomies (integration:github, gh, public, etc.) are forced to adopt github as a required magic string. A per-project setting "Sync issues labeled:" with a default of github would preserve the opt-in pattern while allowing taxonomy flexibility.
Alternatively, if the design intent is "sync all issues when bidirectional is enabled," then the label gate is a bug and should be removed.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Mở trang “how it works” của GitHub integration và tìm phần “What gets synced?”. So sánh cách diễn đạt về bidirectional-sync của phần này với yêu cầu github-label đã được báo cáo, sau đó ghi rõ rằng outbound sync yêu cầu github label không phân biệt chữ hoa chữ thường và giải thích cách áp dụng nó. Hoàn tất khi trang mô tả rõ cơ chế opt-in này và hành vi của các label khác.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- github
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 72/100