Skip to content

Commit dff76cb

Browse files
authored
docs(release): point distribution status at Maven Central + javadoc.io (H3) (#99)
Wires up Track H3 — hosted Javadocs. javadoc.io auto-mirrors any artefact published to Maven Central within minutes, so no separate hosting infrastructure is required; this PR just updates the README distribution status note to point callers at the URL. README distribution note revision: Was: 'currently JitPack. Maven Central is planned for v1.7' Now: 'currently JitPack. Maven Central ships from v1.6.6 under coordinates io.github.demchaav:graphcompose. Hosted Javadocs auto-publish to javadoc.io. JitPack stays available alongside.' The full Central install snippet ('Central as primary, JitPack as fallback') lands in the v1.6.6 release-prep PR after the first Central publish proves the pipeline end-to-end. This PR is the lightweight documentation step that's safe to ship now without waiting on the actual publish event. Verification: ./mvnw test -pl . -Dtest='CanonicalSurfaceGuardTest,DocumentationCoverageTest,VersionConsistencyGuardTest' -> 13 tests, 0 failures (~18s).
1 parent 3c42192 commit dff76cb

2 files changed

Lines changed: 14 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,16 @@ JitPack continue to resolve through the existing coordinates.
4646
secrets, and the release-candidate dry-run strategy. § 2.B
4747
post-release checklist gains a new step 9 for the Central publish
4848
alongside the existing JitPack step.
49+
- **Hosted Javadocs via `javadoc.io`** (Track H3). README's
50+
distribution-status note now points callers at
51+
[javadoc.io/doc/io.github.demchaav/graphcompose](https://javadoc.io/doc/io.github.demchaav/graphcompose),
52+
which auto-mirrors any artefact published to Maven Central within
53+
minutes — no separate hosting infrastructure required. The note
54+
also pins Maven Central as the going-forward primary distribution
55+
starting v1.6.6 (JitPack stays available alongside for existing
56+
callers). The full Central install snippet ("Central as primary,
57+
JitPack as fallback") lands in the v1.6.6 release-prep PR after the
58+
first Central publish proves the pipeline end-to-end.
4959
- **`central-publishing-maven-plugin` in the `release` profile**
5060
(Track D3). Adds Sonatype's `central-publishing-maven-plugin` 0.7.0
5161
to the existing `release` profile as a packaging extension. Replaces

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,10 @@ repositories { maven("https://jitpack.io") }
104104
dependencies { implementation("com.github.demchaav:GraphCompose:v1.6.5") }
105105
```
106106

107-
> **Distribution status** — currently **JitPack**. Maven Central is planned for v1.7 ([tracking issue](https://github.com/DemchaAV/GraphCompose/issues/7)).
107+
> **Distribution status** — currently **JitPack**. **Maven Central**
108+
> ships from **v1.6.6** under coordinates `io.github.demchaav:graphcompose:<version>`;
109+
> hosted Javadocs auto-publish to [javadoc.io/doc/io.github.demchaav/graphcompose](https://javadoc.io/doc/io.github.demchaav/graphcompose) shortly after each Central release.
110+
> JitPack stays available alongside Central for existing callers.
108111
109112
> **Upgrading from v1.5?** Core document authoring stays source-compatible &mdash; engine, DSL, themes, and backend-neutral records carry v1.5 callers unchanged. **Templates v2** replaces the legacy CV / cover-letter template classes; legacy classes were **deleted**, not deprecated. Read the [migration guide](./docs/roadmaps/migration-v1-5-to-v1-6.md) before upgrading template-heavy code.
110113

0 commit comments

Comments
 (0)