docs(release): prep v1.6.6 — Central install snippet + release status + community links (PR-1.6.6)#100
Merged
Merged
Conversation
…block, community links (PR-1.6.6)
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.
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
Final pre-cut PR from the readiness taskboard. Brings README + CHANGELOG up to the shape v1.6.6 will ship in. After this merges,
graphcompose-release-engineercuts v1.6.6.What changes
README
Maven Centralbadge alongsideJitPack.🟢 Latest stable v1.6.5 (JitPack) · 🟡 In develop v1.6.6 (Maven Central debut; zero breaking) · ⚪ Planned next v1.6.7 (dep cleanup), v1.7.0 (new DSL primitives). Links todocs/api-stability.mdfor tier definitions.io.github.demchaav:graphcompose:1.6.6) listed first as the primary path. JitPack snippet stays as fallback / pre-v1.6.6 alternative.CODE_OF_CONDUCT.md,SECURITY.md,docs/api-stability.md,docs/templates/which-template-system.md— files that were committed long ago but never linked from the README.CHANGELOG
v1.6.6 — Plannedsummary expanded to three paragraphs:japicmpagainst v1.6.5 baseline).Version-pinning intent
<dependency>v1.6.5(current pom)cut-release.ps1flips this tov1.6.6at release time, matching theVersionConsistencyGuardTestinvariant (README JitPack snippet == pom version).<dependency>1.6.6(explicit)VersionConsistencyGuardTestonly scans the JitPack snippet (matches<artifactId>GraphCompose</artifactId>— capital G; Central uses lowercasegraphcompose), so the Central pin is exempt from the guard. Maintainer manually bumps this in each subsequent release-prep PR.Verification
Doc guards green, full suite green.
What's next (post-merge)
MAVEN_GPG_PRIVATE_KEY,MAVEN_GPG_PASSPHRASE,CENTRAL_USERNAME,CENTRAL_TOKEN) perdocs/contributing/release-process.md§ 2.C — one-time setup.graphcompose-release-engineerskill:cut-release.ps1bumps the four pom version sites + the JitPack snippet to1.6.6, dates the CHANGELOG, runsverify, commits, tagsv1.6.6, pushes.release.yml— creates the GitHub Release with the CHANGELOG section as the body.publish.yml— signs + uploads to Maven Central; the maintainer flips the "release" switch oncentral.sonatype.comafter Central's validator confirms.javadoc.io/doc/io.github.demchaav/graphcompose/1.6.6becomes available within minutes of the Central publish.Test plan
VersionConsistencyGuardTestpasses (JitPack snippet matches pom; Central snippet exempt by artifactId difference)VersionConsistencyGuardTestto also enforce the Central snippet's1.6.6matches the pom — once Central versioning has shipped a few times and we know the bump cadence we want