Preview Generations

FreeAvailable on every planPreview Generations are unlimited for the linked Project on every plan. Free Targets include 25 operations; review covers the complete Definition.

Preview Generations answer “what will this Definition change do to API consumers and every selected Target?” Typeship resolves the head and base as complete document graphs, so changing only a referenced OpenAPI or GraphQL file still triggers review.

Preview Generations require a GitHub repository Definition. Drafts, base-branch edits, synchronizations, reopens, and typeship:breaking-approved label changes all recompute the result.

The source pull-request surface

Typeship maintains one sticky comment with:

• one peer row per Target;
• objective API compatibility;
• the Diagnostic policy result;
• the Definition entrypoint and immutable commit;
• bounded breaking-change categories, with detailed methods collapsed;
• compatible additions and resolved findings kept available without dominating the review; and
• explicit truncation when either the report or a Free Target is partial.

Two commit statuses remain intentionally separate:

• Typeship – API change review combines objective compatibility with Diagnostic policy. An acknowledged break remains objectively breaking; the label only records the repository's approval decision.
• Typeship – Preview Generations passes only when every configured SDK, CLI, and MCP Target generated.

Both statuses appear on every pull request in a linked source repository. An unrelated pull request passes as not needed without a bot comment. When several Projects share one repository, detailed comments stay per Project and one repository coordinator publishes the worst aggregate status.

The visible report and statuses come from one typed result. A hidden versioned typeship-result record carries the commit, Definition entrypoint, compatibility, acknowledgement, counts, and Target states for agents and automation. Do not scrape prose.

Compatibility

Breaking changes include removed methods or fields, newly required inputs, changed request or response types, changed authentication or pagination, and documented error-contract changes. Additions with optional inputs, documentation, and deprecation changes remain compatible.

OpenAPI and GraphQL use the same compatibility and release semantics, with native parsing and source coordinates for each format. Feature pull requests never change package versions. After source changes merge, destination candidates compare cumulatively against the last surface actually merged in that destination; Typeship – release readiness owns the version decision.

Correctness and races

• Definition patches apply to head and base, so the report reflects the source change.
• Every Target generates independently; one failure cannot hide successful peers.
• Head and base documents are fetched by immutable commit SHA.
• A newer webhook delivery supersedes stale work before any public write.
• A revert updates the existing report instead of leaving a stale failure.
• Public forks are read without executing repository code; unreadable private forks fail explicitly.
• A renamed entrypoint tells the maintainer what path must be updated.