Skip to content

fix: scope SDK documentation publishing by released package - #804

Draft
roncohen wants to merge 1 commit into
mainfrom
fix/manual-sdk-docs-publishing
Draft

roncohen wants to merge 1 commit into
mainfrom
fix/manual-sdk-docs-publishing

Conversation

@roncohen

@roncohen roncohen commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Companion to the page-based GitBook preview in reflagcom/docs#31: reflagcom/docs#31.

Dependency: merge the docs importer from docs#31 before enabling this workflow change. Both PRs remain draft; this does not authorize either merge or an SDK release.

  • Replace whole-tree rm -rf reflag-docs/sdk / copy-from-workspace-HEAD publication.
  • Select only documentation owners that actually appeared in Changesets' published packages output, exclude prereleases, and require matching clean source metadata and exact package tags.
  • Build canonical SDK documentation, then invoke the docs repository's package/major-aware importer. The docs repo owns public routing/banners; SDK READMEs/code comments here remain authoritative.
  • Validate generated provenance/navigation/links before pushing. Do not swallow commit/push errors.
  • Keep package publication unchanged and add four focused release-boundary tests to Package CI.

The importer routes coordinated SDK v1 updates only to legacy/v1/, v2 to current supported-languages/ plus historical aliases, and independent Native/Management/CLI updates only to their own pages. It never owns handwritten guides, navigation or GitBook settings.

Verification

  • Immutable workspace install
  • Four release selection / workflow safety tests
  • Scoped formatting, zero-warning lint and whitespace checks
  • Normal pre-commit hooks
  • Docs importer tests cover version isolation, exact tagged-source checks and GitBook anchor negative controls
  • Both Package CI runs and reported CodeQL checks pass

This PR changes release automation only; no SDK runtime source or dependency versions change. No release workflow was dispatched, npm package/tag changed, docs main branch updated, site setting changed or PR merged.

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