Skip to content

docs: pivot non-version-locked references to Maven-Central-primary (Phase 1)#103

Merged
DemchaAV merged 1 commit into
developfrom
chore/maven-central-docs
May 31, 2026
Merged

docs: pivot non-version-locked references to Maven-Central-primary (Phase 1)#103
DemchaAV merged 1 commit into
developfrom
chore/maven-central-docs

Conversation

@DemchaAV

Copy link
Copy Markdown
Owner

Summary

Phase 1 of the Maven Central coordinate migration: rewrites every forward-facing reference in documentation and CI infrastructure to describe Maven Central as the canonical install channel, while marking the JitPack URL as legacy (kept resolvable for callers pinned to v1.6.5 and earlier but no longer documented as the recommended path).

Why two phases?

Version-locked snippets — README install section, `docs/index.html` JSON-LD + install snippets, and the `VersionConsistencyGuardTest` regex — stay on the JitPack format in this PR because their value has to equal the current `pom.xml` version (`1.6.5`) and Maven Central does not have 1.6.5 (Central debut is at v1.6.6).

Touching those snippets now would either:

  • Fail `VersionConsistencyGuardTest` (if the regex switches to Central format while pom is still 1.6.5), or
  • Advertise a non-resolvable Central coord to anyone who copies the snippet during the prep window.

`cut-release.ps1` will perform the JitPack→Central snippet swap at v1.6.6 cut time in the same release commit that bumps the poms. That's Phase 2 of this migration — lands together with the actual Central debut.

What this PR changes

File Change
`CONTRIBUTING.md` Release-flow steps describe Central publish via `publish.yml`; JitPack confirmation removed
`ROADMAP.md` "Next (v1.7)" entry removed; equivalent "Now (v1.6.x)" entry added
`SECURITY.md` Artifacts line points at Central; JitPack legacy-only
`docs/README.md` Release-process pointer mentions Central instead of JitPack
`docs/SHOWCASE.md` Install-snippet description points at Central artefact URL
`docs/templates/which-template-system.md` "Maven coordinates do not change in 2.0" section reframed Central-first
`docs/roadmaps/v1.6-roadmap.md` Phase E scope rewritten for Central primary; release-identity coords switched
`docs/contributing/release-process.md` Top distribution coords block, Phase 2.B post-release verification (Central artefact poll instead of JitPack BUILD SUCCESS), Phase 3 hotfix protocol opener, Section 5 never-do rule, and Section 6 done-criteria all rewritten. Historical v1.5.0 / v1.6.5 lessons kept verbatim.
`.github/workflows/ci.yml` japicmp comment notes Central as baseline source for v1.6.6+, JitPack still serves v1.6.5
`.github/workflows/publish.yml` Pre-releases ship only to the GitHub Release pre-release surface now

Test plan

  • `./mvnw test -Dtest=CanonicalSurfaceGuardTest,DocumentationExamplesTest,DocumentationCoverageTest,VersionConsistencyGuardTest -pl .` → 30/0/0
  • CI: standard guard suite + JDK 17/21/25 + binary-compat + examples smoke + perf smoke

Independent from PR-102

This PR is decoupled from #102 (EngineShowcase + hero asset). They can land in any order against `develop`.

Phase 1 of the Maven Central coordinate migration: rewrites every
forward-facing reference in the documentation and CI infrastructure to
describe Maven Central as the canonical install channel, while marking
the JitPack URL as legacy (kept resolvable for callers pinned to
v1.6.5 and earlier but no longer documented as the recommended path).

Version-locked snippets are NOT touched in this commit. The README
install section, docs/index.html JSON-LD/install snippets, and the
VersionConsistencyGuardTest regex stay on the JitPack format because
their value has to equal the current pom.xml version (1.6.5) — a
value that does not exist on Maven Central yet. cut-release.ps1 will
flip those at v1.6.6 cut time in the release commit; that mechanical
swap is Phase 2 of this migration and lands together with the actual
Central debut.

Files updated:
- CONTRIBUTING.md release-flow steps now describe Central publish
  via .github/workflows/publish.yml; JitPack confirmation removed
- ROADMAP.md "Next (v1.7)" entry removed; equivalent "Now (v1.6.x)"
  entry added noting Central debut in v1.6.6
- SECURITY.md artifacts line points at Central; JitPack noted as
  legacy-only
- docs/README.md release-process pointer mentions Central instead
  of JitPack
- docs/SHOWCASE.md install-snippet description points at Central
  artefact URL
- docs/templates/which-template-system.md "Maven coordinates do not
  change in 2.0" section reframed Central-first, JitPack as legacy
- docs/roadmaps/v1.6-roadmap.md Phase E scope rewritten for Central
  primary; release-identity coords switched to io.github.demchaav
- docs/contributing/release-process.md: top distribution-coordinates
  block, Phase 2.B post-release verification (Central artefact poll
  instead of JitPack BUILD SUCCESS), Phase 3 hotfix protocol opener,
  Section 5 never-do tag-force-move rule, and Section 6 done-criteria
  all rewritten for Central-primary flow. Historical v1.5.0 / v1.6.5
  lessons-learned kept verbatim (accurate to when they happened)
- .github/workflows/ci.yml japicmp comment notes Central as baseline
  source for v1.6.6+, JitPack still serves v1.6.5
- .github/workflows/publish.yml hyphenated-tag comments drop the
  "go to JitPack" mention; pre-releases ship only to the GitHub
  Release surface now

Guard suite green locally: CanonicalSurfaceGuardTest +
DocumentationExamplesTest + DocumentationCoverageTest +
VersionConsistencyGuardTest = 30/0/0.
@DemchaAV DemchaAV merged commit f5f346b into develop May 31, 2026
11 checks passed
@DemchaAV DemchaAV deleted the chore/maven-central-docs branch May 31, 2026 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant