Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add breaking change policy to website #6049

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply suggestions from code review
Co-authored-by: Brian Terlson <brian.terlson@microsoft.com>
  • Loading branch information
timotheeguerin and bterlson authored Feb 28, 2025
commit 4ed282985d885c32dce7ee5510f8f15390b7c2e9
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add the stdout of the compiler is not a contract, use teh api for programmatic usage

Original file line number Diff line number Diff line change
@@ -16,12 +16,14 @@ TypeSpec Compiler and libraries follow [semver](https://semver.org/) for version

## Breaking Change Philosophy

The basic of the policy can be summarized as follows, we guarantee stability for runtime behavior but not for the build process.
The basic of the policy can be summarized as follows: existing language syntax and semantics will not change without a major version. The runtime behavior for a given TypeSpec will not change without a major version. TypeSpecs leveraging new or updated features may cause runtime API consumers to fail (e.g. because a new type is unhandled) or builds to fail (e.g. because exhaustive unions are no longer exhaustive).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The basic of the policy can be summarized as follows: existing language syntax and semantics will not change without a major version. The runtime behavior for a given TypeSpec will not change without a major version. TypeSpecs leveraging new or updated features may cause runtime API consumers to fail (e.g. because a new type is unhandled) or builds to fail (e.g. because exhaustive unions are no longer exhaustive).
Existing language syntax and semantics will not change without a major version. The runtime behavior for a given TypeSpec will not change without a major version. TypeSpecs leveraging new or updated features may cause runtime API consumers to fail (e.g. because a new type is unhandled in an emitter or library that it uses) or builds to fail (e.g. because exhaustive unions are no longer exhaustive).

``

- The language syntax and semantics for existing language elements will not change within a major version.
- A spec that was building successfully should build successfully with the new version of the compiler and libraries with the same major version.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- A spec that was building successfully should build successfully with the new version of the compiler and libraries with the same major version.
- A spec that builds successfully with a version of the TypeSpec compiler and its libraries will build successfully with a newer version of the compiler and libraries within the same major version.

- New types and functionalities can be added in a minor version release.
- If a spec updates to use that new functionality/type it is not considered a breaking change if it goes through a library/emitter that will now break.
- TypeScript types might change in ways that introcue compilation type checking errors. Those are not considered breaking changes.
- TypeScript types might change in ways that introduce compilation type checking errors. Those are not considered breaking changes.

### Bugs

Loading
Oops, something went wrong.