Skip to content

ci: automate docs/sdk mirror sync from metacore-sdk - #30

Open
akromicc wants to merge 1 commit into
mainfrom
docs/sdk-sync-pipeline-2026-08
Open

ci: automate docs/sdk mirror sync from metacore-sdk#30
akromicc wants to merge 1 commit into
mainfrom
docs/sdk-sync-pipeline-2026-08

Conversation

@akromicc

Copy link
Copy Markdown
Contributor

Por qué

docs/sdk/*.md en este repo es un espejo de metacore-sdk/docs/ copiado a mano, sin ningún script de sync. Por eso se desactualizó en silencio durante meses (el kernel pasó de v0.49 a v0.94 sin que el sitio se enterara) hasta el refresh manual de #29.

Qué hace

  • scripts/sync-sdk-docs.sh <path-a-metacore-sdk>: copia cada docs/*.md de metacore-sdk a docs/sdk/, aplicando dos transforms conocidos:
    1. ./assets/metacore.svg/logo.svg (asset propio del sitio).
    2. Enlaces internos (./archivo.md...)(./archivo...) (routing sin extensión de VitePress), incluyendo el mapeo de los dos únicos archivos renombrados (CONSUMER_GUIDE.mdconsumer-guide.md, PUBLISHING.mdpublishing.md). docs/sdk/index.md nunca se toca — es landing page propia del sitio, sin equivalente en el SDK.
  • .github/workflows/sync-sdk-docs.yml: corre el script diariamente (cron) + on-demand (workflow_dispatch), clonando metacore-sdk (repo público, sin credenciales extra) en un checkout separado. Si hay diffs, abre un PR automático (nunca push directo a main) usando el GITHUB_TOKEN por defecto — no requiere ningún secret nuevo.

Qué falta / decisiones tomadas

  • Sin secrets nuevos: metacore-sdk es público, así que el checkout cross-repo funciona con el token por defecto. Si algún día se vuelve privado, hay que agregar un secret METACORE_SDK_READ_TOKEN (PAT scope repo, solo lectura) — dejé el comentario en el workflow.
  • docs/es/sdk/ no se toca: es traducción real, no copia — el PR automático solo lista qué archivos es/ quedaron potencialmente desincronizados (mismo basename que un docs/sdk/*.md tocado) para revisión manual; no traduce automáticamente.
  • metacore-kernel/docs/ no se sincroniza con nada — son docs internas propias del kernel (arquitectura Go), no un espejo de otro repo, así que no aplica este pipeline.
  • Probé el script localmente contra el estado actual (ya sincronizado tras docs(sdk): sync mirrored SDK docs with metacore-sdk#748 refresh #29): confirma "no changes", como se espera.

Daily scheduled workflow clones the public metacore-sdk repo, runs a
copy+transform script against its docs/, and opens a PR here if the
mirror drifted — replacing the manual copy-paste that let docs/sdk/
silently fall behind metacore-sdk#748 (kernel v0.49 -> v0.94).
@coderabbitai

coderabbitai Bot commented Aug 15, 2026

Copy link
Copy Markdown

Important

Review available on request

  • 🔍 Trigger review

Reviews should be triggered manually for repositories with fewer than 10 stars. Select Trigger review above or comment @coderabbitai review to review the latest changes. For a full review, comment @coderabbitai full review.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 7c6b079b-8d3e-4f12-83d1-dcd88f274337


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant