From 2144cd81ef037b3b7d8d90d1429b4f6ff0c7439d Mon Sep 17 00:00:00 2001 From: Alejandro Rosas Date: Fri, 30 Oct 2026 18:05:22 +0000 Subject: [PATCH] DID-9476: [QA-SDK-JAVA] Java server SDK release contract --- CONTRIBUTING.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6131eb3..8fd4949 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,7 +48,7 @@ You can push commits to the sync branch (for example hand-written webhook or Aut ## Releases -Releases are cut by release-please from conventional commits; `CHANGELOG.md` is generated and never edited by hand. Nothing is published before Alex approves the first release, and not before 2026-11-01; until then versions stay `0.x`. +Releases are cut by release-please from conventional commits; `CHANGELOG.md` is generated and never edited by hand. The first release, 1.0.0, shipped on 2026-10-29 with Alex's approval; every release after that publishes straight from the repository (DESIGN 13). 1. The workflow `.github/workflows/release-please.yml` runs while the repository variable `RELEASES_ENABLED` is `true` (set since 1.0.0). Merging the release pull request is the release approval (Alex, 2026-10-29); nobody tags or publishes by hand. 2. On each push to `main`, release-please updates a release pull request (version in `gradle.properties`, `Version.java` and the README, plus `CHANGELOG.md`). diff --git a/README.md b/README.md index 4b02125..8c53780 100644 --- a/README.md +++ b/README.md @@ -283,7 +283,7 @@ Choices this SDK makes where the shared design leaves room: ## Supported runtimes and versioning - Java 11, 17, 21 and 25 on Linux, macOS and Windows; Kotlin 2.x. -- Semantic versioning: a breaking change to the public SDK surface is a major version. Until 1.0.0, versions are `0.x`. +- Semantic versioning: a breaking change to the public SDK surface is a major version. The first release, 1.0.0, shipped on 2026-10-29; every release after that is cut by release-please, and merging its pull request is the release approval. - The SDK is generated from the OpenAPI documents Didit publishes at docs.didit.me and is updated when they change: endpoints the API removes stay one minor version, deprecated, before they go. - Releases and their notes are in [CHANGELOG.md](CHANGELOG.md).