From fbafcc6681a18be4de6de4c2316b8c78fcd0e0b7 Mon Sep 17 00:00:00 2001 From: jgjesdal Date: Fri, 2 Oct 2026 13:59:02 +0200 Subject: [PATCH] Install the Java SDK 1.0.0 from Maven Central The platform's release-prep/v1.0.0 sets 1.0.0, the first Maven Central release of datahub-sdk and datahub-api-model, which made the "not on Maven Central / 0.3.0-SNAPSHOT" install instructions wrong. Co-Authored-By: Claude Opus 5.5 (1M context) Signed-off-by: jgjesdal --- AGENTS.md | 6 +++--- docs/quickstart.mdx | 27 +++++++++++---------------- docs/tutorial.mdx | 7 ++----- 3 files changed, 16 insertions(+), 24 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 1586a1f..cc46bf8 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -75,8 +75,8 @@ nvm install 22 && nvm use 22 # or fnm, or a NodeSource apt package ## Versions: which SDK these pages describe -The SDKs are pre-1.0 and still change their interfaces between versions (the platform's -`FAQ.md` says so), so one page cannot be right for every release. These are the rules for +The Python and Rust SDKs are pre-1.0 and still change their interfaces between versions (the +platform's `FAQ.md` says so), so one page cannot be right for every release. These are the rules for that. Nothing like them was written down before 2026-09-17, and by then the examples matched no SDK version at all: some calls only the released 0.2.0 had, some only `main`. @@ -85,7 +85,7 @@ SDK version at all: some calls only the released 0.2.0 had, some only `main`. | SDK | What `master` describes | How it is released | | --- | --- | --- | | Python and Rust | `main` of [dataplatform-rust-sdk](https://github.com/IntelliStream-DataHub/dataplatform-rust-sdk) | `intellistream-datahub-sdk` on PyPI and crates.io, from a `vX.Y.Z` tag | -| Java | the default branch of [datahub-platform](https://github.com/IntelliStream-DataHub/datahub-platform) | not released; its version is `javaSdkVersion` in that repo's `gradle.properties` | +| Java | the default branch of [datahub-platform](https://github.com/IntelliStream-DataHub/datahub-platform) | `ai.intellistream:datahub-sdk` on Maven Central, from a `vX.Y.Z` GitHub Release of that repo; its version is `version` in that repo's `gradle.properties` | The platform already works this way: its `docs-check` skill sends a user-visible change here, "changed API or SDK contracts" included, when the change merges, not when it is released. The diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 015d500..b9bf7e7 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -13,43 +13,38 @@ From zero to a stored datapoint in about five minutes. :::note Which version these pages describe These pages follow the SDKs as they are being developed, which can be ahead of the latest -release. The SDKs are pre-1.0, so a release can still rename or remove a call. If an example -calls something your installed SDK does not have, it may be newer than your release. +release. The Python and Rust SDKs are pre-1.0, so a release can still rename or remove a call. +If an example calls something your installed SDK does not have, it may be newer than your release. | SDK | Latest release | | --- | --- | | Python | 0.2.0, on PyPI | | Rust | 0.2.0, on crates.io | -| Java | Not released yet, so it is built from the platform repository below | +| Java | 1.0.0, on Maven Central | ::: -The Java SDK is not on Maven Central yet, so build it from the platform repository and -install it into your local Maven repository once: - -```bash -git clone https://github.com/IntelliStream-DataHub/datahub-platform.git -cd datahub-platform -./gradlew :datahub-api-model:publishToMavenLocal :datahub-java-sdk:publishToMavenLocal -``` - -Then depend on it. The version is `javaSdkVersion` in the platform's `gradle.properties`, -`0.3.0-SNAPSHOT` on its default branch: +The Java SDK is on Maven Central and needs Java 25 or newer. It brings +`datahub-api-model` with it, so one dependency is enough: ```kotlin // build.gradle.kts repositories { - mavenLocal() mavenCentral() } dependencies { - implementation("ai.intellistream:datahub-sdk:0.3.0-SNAPSHOT") + implementation("ai.intellistream:datahub-sdk:1.0.0") } ``` +To try calls newer than the release, build the SDK from the +[platform repository](https://github.com/IntelliStream-DataHub/datahub-platform) with +`./gradlew :datahub-api-model:publishToMavenLocal :datahub-java-sdk:publishToMavenLocal`, +add `mavenLocal()` to `repositories`, and use the `version` from its `gradle.properties`. + diff --git a/docs/tutorial.mdx b/docs/tutorial.mdx index e7aa9e5..c2a9180 100644 --- a/docs/tutorial.mdx +++ b/docs/tutorial.mdx @@ -55,9 +55,7 @@ the token variant shown in step 1. See One dependency and a main class. Memory and swap come from a JDK-builtin API, so -nothing extra is needed for that. The SDK comes from your local Maven repository, so run -the `publishToMavenLocal` step from the [quick start](/quickstart#1-install) first if you -have not already: +nothing extra is needed for that. The SDK comes from Maven Central: ```kotlin // build.gradle.kts @@ -66,12 +64,11 @@ plugins { } repositories { - mavenLocal() mavenCentral() } dependencies { - implementation("ai.intellistream:datahub-sdk:0.3.0-SNAPSHOT") + implementation("ai.intellistream:datahub-sdk:1.0.0") } application {