docs: declare the 2.0 module split in the stability ledger and changelog#293
Merged
Conversation
Record the upcoming multi-module packaging as a 2.0 breaking change before the extraction PRs land: add a row to the api-stability §3 ledger and a Packaging note to the CHANGELOG v2.0.0 Planned entry describing the split into a lean graph-compose core plus graph-compose-render-pdf / graph-compose-render-docx / graph-compose-templates / graph-compose-testing, with render backends discovered via a ServiceLoader SPI and a graph-compose-bundle batteries-included coordinate. Also align the showcase downloadUrl with the 2.0.0 softwareVersion it sits beside (was a stale 1.9.0). Tests: doc guards (VersionConsistencyGuardTest + surface/coverage/snippet guards) — 26 tests, 0 failures.
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.
Why
First step of the 2.0 modularization (Maven module split) — declare it publicly before any code moves, so the breaking change is on record for the migration guide.
What
docs/api-stability.md§3 (2.0 breaking-changes ledger) — a row for thegraph-composesingle-jar → multi-module split: lean core keeps the coordinate but sheds the PDF backend / templates; addgraph-compose-render-pdf(orgraph-compose-bundle) for PDF output.CHANGELOG.mdv2.0.0 Planned — a### Packagingnote describing the module set (graph-compose,-render-pdf,-render-docx,-templates,-testing,-bundle) and the ServiceLoader backend discovery.web/index.html— align the schemadownloadUrlwith the2.0.0softwareVersionit sits next to (was a stale1.9.0).No production code. This is PR-A0 of the modularization phase plan.
Tests
Doc guards —
VersionConsistencyGuardTest,CanonicalSurfaceGuardTest,DocumentationCoverageTest,DocumentationSnippetCompileTest,PackageMapGuardTest— 26 tests, 0 failures.