docs: correct the v2.1.0-beta / 2.2.0-beta split in CHANGELOG, BREAKING, migration.md - #894
Merged
Merged
Conversation
…NG, migration.md v2.1.0-beta was tagged 2026-07-30 and is registered in ct-registry; every PR since (#830 through #893) landed in 2.2.0-beta instead. Two campaign reports called 2.1.0-beta the target, which prompted this audit; it found the mix-up is also baked into three published files. - CHANGELOG.md: rewrite the [2.2.0-beta] entry under the Handbook's emoji section taxonomy. Add the missing entries: the five v2.0 compatibility shims (#855, src/deprecated.jl — added two weeks after the v2.1.0-beta tag, so a copy pinned to that exact tag still gets a bare UndefVarError/MethodError instead of a named PreconditionError) and #853 (explicit solve now rejects unconsumed options, near-breaking). Add the missing markdownlint-disable MD024 header line the Handbook's own template specifies. - BREAKING.md: restructure to a single H1 with a three-line index; the two former H1 epoch sections and everything nested under them demoted one level (34 headings, each checked against its exact text before editing so a `#`-prefixed code comment inside a fenced block couldn't be mistaken for a heading). Add the #853 near-breaking note next to the existing ExaModels one. - docs/src/migration.md: add a warning box clarifying that the informative shim messages need 2.2.0-beta, not just the v2.1.0-beta tag; give "What you get instead of an error" an explicit @id so the box can link to it. No source file touched; nothing to test beyond the docs build. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Summary
v2.1.0-betawas tagged 2026-07-30 (ct-registry) and is not in General. Every PR since(#830 through #893) landed in 2.2.0-beta instead — but three published files still
attribute post-tag behaviour to
v2.1.0-beta.Found while auditing the documentation campaign's own reports for the same mix-up
(they said "Target: v2.1.0-beta" and were corrected first).
What's wrong today
src/deprecated.jl(the five v2.0 → v2.1 compatibility shims, PR feat(deprecation): v2.0 compatibility shims for v2.1.0-beta #855) was added2026-08-15, two weeks after the
v2.1.0-betatag. It is in neither CHANGELOG entry.docs/src/migration.mdreads as if every removed spelling already gets a namedPreconditionError"in v2.1.0-beta" — false for that exact tag, which still throws abare
UndefVarError/MethodError.solvenow rejects unconsumed keyword arguments instead ofsilently ignoring them — near-breaking) is in neither
CHANGELOG.mdnorBREAKING.md.BREAKING.mdhas three#H1 sections and no index.CHANGELOG.md's[2.2.0-beta]entry doesn't follow the Handbook's emoji sectiontaxonomy (
philosophy/changelog.md), unlike CTParser 0.9.0 and CTDirect's changelog.What changed
[2.2.0-beta]entry rewritten under the emoji taxonomy (✨ 🐛 🛠🔄 🧪 📚 📦 ✅). New ✨ entry for the shims, explicit that they postdate the
v2.1.0-betatag. New 🛠 entry for Reject unconsumed options in explicit solve mode #853. New 🔄 line for the docs-build label gate(ci(docs): build the documentation on documentation-relevant pull requests #875 reverted by ci(docs): restore the 'run documentation' label gate #876). ✅ footer now names two near-breaking notes. Added the
<!-- markdownlint-disable MD024 -->header the Handbook template specifies.Scope: only
[2.2.0-beta]converted; older entries untouched.everything nested under them (34 headings) demoted one level. Anchors are text-based
in GitHub markdown, so the one external reference
(
docs/src/migration.md→#breaking-changes-v1x--v20) still resolves — checked.Added the Reject unconsumed options in explicit solve mode #853 near-breaking note.
messages need 2.2.0-beta, not just the
v2.1.0-betatag. Gave "What you get insteadof an error" an explicit
@idso the box can link to it. The other tenv2.1.0-betamentions on the page were read individually and left as-is — eachcorrectly describes when a spelling stopped working, not the shim behaviour.
Verification
No source file touched — documentation coherence only, no test run needed.
🤖 Generated with Claude Code