Repository navigation
docs: release notes for interface-database 0.3.0 - #70
Merged
Merged
Conversation
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
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.
Why
Antony's goal is a joint release whose users learn every breaking or behaviour change before they upgrade. The release workflow cannot carry these notes on its own. It calls
release-npm-public.yml@v1, which runs release-it withrelease-it-changelogen. That plugin builds both theCHANGELOG.mdentry and the GitHub release body from commit subjects only. It inserts its generated block before the first##or###heading ofCHANGELOG.md, and reads no other file. Several of the changes below have no!in their subject, so the generated text would not mark them (release rehearsal 2026-11-02, blocker 12).What changed
UPGRADING.md, holding the upgrade notes of@antelopejs/interface-database0.3.0. The repos already put an "Upgrade notes" block in the changelog by hand after a release (interface-database#38). Keeping it in its own file means the release commit's changelog insertion does not split or duplicate it. After the release, paste the section into the GitHub release body and under the version's heading inCHANGELOG.md.unknownoperands,interface-typed records inconstant/default/sub/merge/the default ofkey, genericK extends keyof Tkeys) and its PR link. New bullets describe feat(database)!: type every query stage by name #51 (stages typed by name,eq/ne,pluck/without,keyof T & stringnames,betweenbounds,addoperands) and feat(database)!: type written documents as write values #59 (written documents typed as write values). Sources: the bodies of feat(database)!: type every query stage by name #51, feat(database)!: type written documents as write values #59 and feat(database)!: type the operands of query stages as query values #62.Proofs
pnpm run checks:Checks: 8 passed, 0 failed.(round 2 head).Attention
CHANGELOG.mdis a hand step for whoever runs the release. Nothing automates it.