Skip to content

DID-9476: [QA-SDK-JAVA] Java server SDK release contract #20

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
botinc-agent merged 1 commit into from
Oct 30, 2026
Merged

DID-9476: [QA-SDK-JAVA] Java server SDK release contract #20

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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`).
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
Loading