makeplane / makeplane/developer-docs
Outbound Plane→GitHub sync requires hardcoded "github" label , undocumented
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 16
- Fork
- 23
- Merge medio
- 46m
- PR unite (30g)
- 1
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Apri la pagina “how it works” dell’integrazione GitHub e individua la sezione “What gets synced?”. Confronta la formulazione relativa alla sincronizzazione bidirezionale con il requisito github-label segnalato, quindi documenta che la sincronizzazione in uscita richiede il github label senza distinzione tra maiuscole e minuscole e spiega come applicarlo. Il lavoro è completato quando la pagina descrive chiaramente questo vincolo di opt-in e il comportamento delle altre label.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- github
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 72/100