From ccb6ab9ccee834f65ab3df9cc1dfe6ba2617023d Mon Sep 17 00:00:00 2001 From: DemchaAV Date: Sun, 31 May 2026 17:56:08 +0100 Subject: [PATCH] =?UTF-8?q?docs(release):=20prep=20v1.6.6=20=E2=80=94=20Ce?= =?UTF-8?q?ntral=20install=20snippet,=20release=20status=20block,=20commun?= =?UTF-8?q?ity=20links=20(PR-1.6.6)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Wires up the final pre-cut PR from the readiness taskboard. Brings README + CHANGELOG up to the shape v1.6.6 will ship in. cut-release.ps1 will flip the JitPack snippet to v1.6.6 at release time as usual; the Central snippet is already pinned at v1.6.6 since v1.6.5 was never on Central. Changes: README install section restructured. Maven Central (io.github.demchaav:graphcompose:1.6.6) listed first as the primary path; the JitPack snippet stays as fallback / pre-v1.6.6 alternative. README hero adds a Maven Central badge alongside the JitPack badge. README gains a 'Release status' block under the badges: latest stable v1.6.5 / in develop v1.6.6 / planned next v1.6.7 + v1.7.0, with a link to the API stability policy. README footer 'Contributing & releases' section gains links to CODE_OF_CONDUCT.md, SECURITY.md, docs/api-stability.md, docs/templates/which-template-system.md - the community files were committed long ago but never linked from the README. CHANGELOG v1.6.6 — Planned summary expanded to three paragraphs: what shipped, zero-breaking guarantee, migration-from-v1.6.5 sentence ('no code changes required; optionally swap to the Central coordinates'). Verification: ./mvnw test -pl . - 1033 tests, 0 failures (~91s). Doc guards green - JitPack snippet pinned to current pom version (1.6.5); Central snippet uses lowercase artifactId so the VersionConsistencyGuardTest regex doesn't scan it (intentional - Central versions are bumped manually in release-prep PRs). After this PR merges, the v1.6.6 cut runs through graphcompose-release-engineer: cut-release.ps1 flips JitPack snippet to v1.6.6, dates the CHANGELOG, tags v1.6.6, pushes; release.yml creates the GitHub Release; publish.yml uploads to Maven Central (assuming the four secrets are wired); javadoc.io auto-mirrors within minutes. --- CHANGELOG.md | 23 +++++++++++++++++++---- README.md | 26 +++++++++++++++++++++++++- 2 files changed, 44 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c6182c73..5f78c907 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,10 +5,25 @@ follow semantic versioning; release dates are ISO 8601. ## v1.6.6 — Planned -First Maven Central release. Adds publishable sources/javadoc jars, -GPG-signed artifacts, a binary-compatibility gate against v1.6.5, and -the metadata Maven Central requires. Zero breaking changes; users on -JitPack continue to resolve through the existing coordinates. +**First Maven Central release.** GraphCompose now ships under +`io.github.demchaav:graphcompose:1.6.6` alongside the existing +JitPack distribution. The release adds publishable sources/javadoc +jars, GPG-signed artefacts, a binary-compatibility gate against +v1.6.5, the metadata Maven Central requires, and a substantial +documentation polish for the maturity / stability / migration story. + +**Zero breaking changes from v1.6.5.** Existing JitPack callers continue +to resolve through the same coordinates; existing API surface compiles +and runs unchanged (validated by the new `japicmp` gate against the +v1.6.5 baseline). New: the `@Beta` annotation marker, the `@since 1.0.0` +class-level Javadoc on entry-point packages, and a curated docs pass +(decision guide for the two template surfaces, examples maturity index, +explicit API stability policy). + +**Migration from v1.6.5:** no code changes required. Optionally swap +the JitPack `` for the Maven Central equivalent +(`io.github.demchaav:graphcompose:1.6.6`); both publish paths continue +to ship the same artefact. ### Build diff --git a/README.md b/README.md index 1abbf7ce..ae086ee0 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,19 @@

CI Latest release + Maven Central JitPack Java 17+ PDFBox 3.0 MIT License

+> **Release status** — +> 🟢 **Latest stable**: [v1.6.5](https://github.com/DemchaAV/GraphCompose/releases/tag/v1.6.5) (JitPack) +>  ·  🟡 **In develop**: v1.6.6 (Maven Central debut; zero breaking from v1.6.5) +>  ·  ⚪ **Planned next**: v1.6.7 (dependency cleanup), v1.7.0 (new canonical DSL primitives) +>  ·  See [API stability policy](./docs/api-stability.md) for tier definitions. +

Live Showcase  ·  @@ -87,6 +94,22 @@ GraphCompose uses PDFBox under the hood as the rendering backend — the com ## Installation +### Maven Central (primary, from v1.6.6) + +```xml + + io.github.demchaav + graphcompose + 1.6.6 + +``` + +```kotlin +dependencies { implementation("io.github.demchaav:graphcompose:1.6.6") } +``` + +### JitPack (fallback / pre-v1.6.6) + ```xml jitpack.iohttps://jitpack.io @@ -206,7 +229,8 @@ document.pageFlow().addCanvas(523, 360, canvas -> canvas - [Examples gallery](./examples/README.md) — every runnable example with PDF preview ### Contributing & releases -- [Migration v1.5 → v1.6](./docs/roadmaps/migration-v1-5-to-v1-6.md) · [Release process](./docs/contributing/release-process.md) · [Contributing](./CONTRIBUTING.md) +- [Contributing](./CONTRIBUTING.md) · [Code of conduct](./CODE_OF_CONDUCT.md) · [Security policy](./SECURITY.md) · [Release process](./docs/contributing/release-process.md) +- [API stability policy](./docs/api-stability.md) · [Which template system?](./docs/templates/which-template-system.md) · [Migration v1.5 → v1.6](./docs/roadmaps/migration-v1-5-to-v1-6.md) ## Companion projects