Commit bfaa839
authored
docs(release): prep v1.6.6 — Central install snippet, release status block, community links (PR-1.6.6) (#100)
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.1 parent dff76cb commit bfaa839
2 files changed
Lines changed: 44 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
9 | | - | |
10 | | - | |
11 | | - | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
12 | 27 | | |
13 | 28 | | |
14 | 29 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| 15 | + | |
15 | 16 | | |
16 | 17 | | |
17 | 18 | | |
18 | 19 | | |
19 | 20 | | |
20 | 21 | | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
21 | 28 | | |
22 | 29 | | |
23 | 30 | | |
| |||
87 | 94 | | |
88 | 95 | | |
89 | 96 | | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
90 | 113 | | |
91 | 114 | | |
92 | 115 | | |
| |||
206 | 229 | | |
207 | 230 | | |
208 | 231 | | |
209 | | - | |
| 232 | + | |
| 233 | + | |
210 | 234 | | |
211 | 235 | | |
212 | 236 | | |
| |||
0 commit comments