docs: release notes for the next release - #1221
Merged
Merged
Conversation
Step 0 of the release flow. check-release-notes.yml gates the develop → main promotion PR on a dated file existing with all three sections and no `(write here)` placeholder left. This release carries one pending changeset (patch), so it cuts v0.16.1. Its user-facing content is the OpenAPI contract fix: the published spec had the wrong path prefix, a localhost server URL, a frozen version, and four documented endpoints that did not exist. For an agent-facing API that document is the first thing a caller reads, so all three Fixed / Changed bullets are about it. The remaining work in the release — the test-suite flake and the dependency advisories — is developer-facing only, so it collapses into the technical-bucket bullets per the template's style rules. Empty changeset: docs-only, no package change.
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.
Closes #1220
Step 0 of the release flow in CLAUDE.md.
check-release-notes.ymlgates thedevelop→mainpromotion PR on a dated.github/release-notes-<yyyymmdd>.mdexisting with all three sections filled in, so this has to land on develop first.Release contents
One pending changeset (
fix-openapi-v1-prefix.md, patch) → v0.16.1. Eight non-merge commits sincemain, all from #1217:/api/v1/openapi.jsonwas wrong — paths missing/v1,servers[0].urlhardcoded to localhost, frozeninfo.version, four phantom admin pathsauditjob red on every PR from 8 high advisoriesNotes
The spec fix gets real bullets because for an agent-facing API that document is the first thing a caller reads. The flake fix and dependency bumps are developer-facing only, so they collapse into the technical buckets per the template's style rules.
Copied from the immutable template; gate simulated locally — all three headings present, no
(write here)remaining. Empty changeset since this is docs-only.