Outbound Plane→GitHub sync requires hardcoded "github" label , undocumented

未关闭 适合新手
#262 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
72/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
冷清
技术栈
github
领域
documentation

调研方向

打开 GitHub integration 的“how it works”页面,并找到“What gets synced?”部分。将其中关于双向同步的措辞与已报告的 github-label 要求进行比较,然后记录 outbound sync 要求不区分大小写的 github label,并说明如何应用它。完成标准是页面清楚地描述这一 opt-in 门槛以及其他标签的行为。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
JavaScript
星标
16
派生
23
平均合并
46 分钟
30 天内合并 PR
1

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

makeplane/developer-docs 的其他 Issue

查看 makeplane/developer-docs 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。