makeplane / makeplane/developer-docs

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

Abierto Apto para principiantes
#262 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
JavaScript
Estrellas
16
Forks
23
Merge medio
46 min
PR fusionados (30 d)
1

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Abre la página de la integración de GitHub “how it works” y localiza la sección “What gets synced?”. Compara su redacción sobre la sincronización bidireccional con el requisito de github-label indicado y documenta que la sincronización saliente requiere la etiqueta github sin distinguir entre mayúsculas y minúsculas, además de explicar cómo aplicarla. Se considera terminado cuando la página describa claramente esta condición de opt-in y el comportamiento de las demás etiquetas.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
github
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
72/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.