Skip to content

Install the Java SDK 1.0.0 from Maven Central #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JosteinGj merged 1 commit into from
Oct 5, 2026
Merged

Install the Java SDK 1.0.0 from Maven Central #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand All @@ -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
Expand Down
27 changes: 11 additions & 16 deletions docs/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
:::

<Tabs groupId="lang">
<TabItem value="java" label="Java">

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`.

</TabItem>
<TabItem value="python" label="Python">

Expand Down
7 changes: 2 additions & 5 deletions docs/tutorial.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,7 @@ the token variant shown in step 1. See
<TabItem value="java" label="Java">

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
Expand All @@ -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 {
Expand Down
Loading