Skip to content

docs(sdk): contain unrelated Platform regeneration - #551

Merged
lilienblum merged 6 commits into
mainfrom
dan/alien-635-commands-operations
Sep 10, 2026
Merged

lilienblum merged 6 commits into
mainfrom
dan/alien-635-commands-operations

Conversation

@lilienblum

@lilienblum lilienblum commented Aug 31, 2026 •

Copy link
Copy Markdown
Contributor

Adds repository guidance that keeps Platform TypeScript SDK generation reproducible and prevents unrelated Speakeasy churn from leaking into feature PRs.

The supported pipeline must first copy the same Platform OpenAPI contract into all three checked-in mirror files. Feature-owned generated models and docs stay with the feature; unrelated generator rewrites are restored and handled in a dedicated SDK-sync PR.

No generated SDK model is included here. The ALIEN-635 Platform schema is intentionally deferred until Platform and Alien have a generator-clean OpenAPI baseline; generating against mismatched mirrors would create output that the checked-in sources cannot reproduce.

Verification:

  • diff against current Alien main is limited to client-sdks/AGENTS.md
  • generated SDK files are byte-identical to Alien main
  • public/private boundary reviewed
  • git diff --check passed

Linear: https://linear.app/alienplatform/issue/ALIEN-635/define-commands-vs-operations-and-add-typed-operation-schemas

Companion PRs:

@greptile-apps

greptile-apps Bot commented Aug 31, 2026 •

Copy link
Copy Markdown

Greptile Summary

Updates the client SDK contributor guidance to document the Platform API generation pipeline and how to isolate unrelated Speakeasy-generated drift into a dedicated SDK-sync PR.

  • Lists the three synchronized Platform OpenAPI contract files.
  • Clarifies that feature-related generated models and documentation should be retained.
  • Directs unrelated generated changes into a separate synchronization PR.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
client-sdks/AGENTS.md Clarifies Platform SDK generation and drift-handling guidance without changing runtime behavior.

Reviews (5): Last reviewed commit: "fix(sdk): keep generated clients reprodu..." | Re-trigger Greptile

@lilienblum lilienblum changed the title feat(sdk): expose operation schemas docs(sdk): contain unrelated Platform regeneration Sep 1, 2026
@lilienblum
lilienblum merged commit 534d664 into main Sep 10, 2026
25 checks passed
@lilienblum
lilienblum deleted the dan/alien-635-commands-operations branch September 10, 2026 11:08
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