Skip to content

docs: correct the 2.1.0 range-resolution note - #98

Open
StuartMeeks wants to merge 1 commit into
mainfrom
docs/correct-2.1.0-range-resolution-note
Open

StuartMeeks wants to merge 1 commit into
mainfrom
docs/correct-2.1.0-range-resolution-note

Conversation

@StuartMeeks

@StuartMeeks StuartMeeks commented Sep 21, 2026 •

Copy link
Copy Markdown
Owner

What

Corrects a factual error in the released 2.1.0 CHANGELOG entry.

The error

The 2.1.0 note read:

No provider-facing interface changed, so this is a minor and the provider packages need no re-cut: their [2.0.0, 3.0.0) dependency range resolves against 2.1.0 unchanged.

The second clause is wrong. NuGet resolves a version range to its floor (lowest-applicable-version), so the 2.x providers' [2.0.0, 3.0.0) dependency resolves to core 2.0.0, not 2.1.0. Consumers of the providers therefore did not pick up 2.1.0 — including its keystore data-loss fix — automatically.

The correction

The note now states that 2.1.0 is API-compatible (existing provider assemblies keep working), but does not reach provider consumers on its own; a downstream consumer keeps resolving core 2.0.0 until the provider packages raise their floor to [2.1.0, 3.0.0) and re-cut.

Docs-only; the first (correct) clause about API compatibility is preserved. The note deliberately names no specific downstream provider version — that is the providers' repo to record, and coupling it here would go stale. No [Unreleased] entry — consistent with how the estate handles changelog/doc corrections.

The 2.1.0 entry claimed the provider packages "need no re-cut: their
[2.0.0, 3.0.0) dependency range resolves against 2.1.0 unchanged."
That is wrong. NuGet resolves a version range to its floor
(lowest-applicable-version), so the 2.x providers' [2.0.0, 3.0.0)
dependency resolves to core 2.0.0, not 2.1.0. Downstream consumers of
the providers therefore did not pick up the 2.1.0 keystore data-loss
fix at all.

Correct the note to say the fix reaches downstream consumers only once
the provider packages raise their floor to [2.1.0, 3.0.0) and re-cut,
so other consumers of this package are not misled into thinking a core
minor reaches them on its own. Keep the note free of any specific
downstream provider version — that is the providers' repo to record,
and coupling it here would go stale.
@StuartMeeks
StuartMeeks force-pushed the docs/correct-2.1.0-range-resolution-note branch from 88d3e6c to b8c997d Compare September 21, 2026 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant