docs: Consolidate the changelog for v1.0.0 - #52
Merged
Merged
Conversation
Three PRs since v0.5.0 turned the public API into something worth freezing: the engine types are declared here instead of aliased, Run is the only entry point, and three incidental exports are gone. Promote them to a 1.0.0 section and say what the version number now means, which is that a breaking change costs a /v2 import path rather than a major bump. The API-compatibility job stays advisory in this release. It compares against the newest tag, and until v1.0.0 exists that tag is v0.5.0, which this release deliberately breaks from. It turns blocking in the commit after the tag. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GuMYXaDafWUk2fAjyEvFDa
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Three PRs have accumulated under
[Unreleased]since v0.5.0, and together they are thereason to cut a 1.0.0 rather than a 0.6.0: the public API is finally something worth
freezing. Without a versioned section there is nothing to tag, and
scripts/changelog-notes.shrefuses to publish empty release notes.Solution
Promote the entries to a
[1.0.0]section and say what the version number now means.Until now a breaking change cost a minor bump. From here it costs a
/v2import path andan edit in every caller, so the bar for removing or renaming anything is permanently
higher. Additions stay additions.
Nothing about the measurement changes. The algorithm, the wire behaviour and
schema_versionare identical to 0.5.0.Other Changes
The API-compatibility CI job stays advisory for this one release. It compares the branch
against the newest tag, and until v1.0.0 exists that tag is v0.5.0, which this release
deliberately breaks from. I checked rather than assumed:
scripts/api-compat.shon thisbranch reports eighteen incompatible changes against v0.5.0 and exits non-zero, so
flipping the job to blocking here would fail the release PR itself. The flip follows
immediately after the tag, when there is a v1 to compare against, and that PR also
updates
docs/guidelines.mdandAGENTS.md.No screenshots: nothing rendered changed.
Related: #50, #51
🤖 Generated with Claude Code
https://claude.ai/code/session_01GuMYXaDafWUk2fAjyEvFDa