From 58643e02cf78643a5cfc35c8523a8d1329aacb9b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Wokacz?= Date: Tue, 10 Nov 2026 15:13:16 +0100 Subject: [PATCH] chore(release): bump version to 2.0.0 Promote Unreleased to 2.0.0 in CHANGELOG, bump the BOM coordinate in README, and add UPGRADING sections for the #120, #96 and #113 breaking changes. Co-Authored-By: Claude Opus 5.5 (1M context) --- CHANGELOG.md | 10 +++++++++- README.md | 2 +- UPGRADING.md | 28 ++++++++++++++++++++++++++++ gradle.properties | 2 +- 4 files changed, 39 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f68768c6..e60e9e1e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,13 @@ Until `1.0.0`, breaking changes may appear in any release and are flagged with * ## [Unreleased] +## [2.0.0] — 2026-11-10 + +First major release since 1.0.0. It fixes bugs whose fixes could not ship without breaking +compatibility: database schema migrations for MySQL (#138) and PostgreSQL (#135), exponential retry +backoff (#131), listener events after commit (#137) and backlog draining within a scheduler tick (#132). +Read [UPGRADING.md](UPGRADING.md#from-1x-to-200) before upgrading. + ### Added - **`x-outbox-id` header on every delivery.** Both `KafkaMessageDeliverer` and `HttpMessageDeliverer` @@ -386,7 +393,8 @@ Initial public release. - `okapi-exposed` integration (transaction runner, connection provider, validator). - Concurrent processing via `FOR UPDATE SKIP LOCKED`. -[Unreleased]: https://github.com/softwaremill/okapi/compare/v1.0.0...HEAD +[Unreleased]: https://github.com/softwaremill/okapi/compare/v2.0.0...HEAD +[2.0.0]: https://github.com/softwaremill/okapi/compare/v1.0.0...v2.0.0 [1.0.0]: https://github.com/softwaremill/okapi/compare/v0.3.0...v1.0.0 [0.3.0]: https://github.com/softwaremill/okapi/compare/v0.2.0...v0.3.0 [0.2.0]: https://github.com/softwaremill/okapi/compare/v0.1.0...v0.2.0 diff --git a/README.md b/README.md index a09be970..e1dc0650 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ This example assumes an existing Spring Boot application connected to PostgreSQL ```kotlin dependencies { - implementation(platform("com.softwaremill.okapi:okapi-bom:1.0.0")) + implementation(platform("com.softwaremill.okapi:okapi-bom:2.0.0")) implementation("com.softwaremill.okapi:okapi-core") implementation("com.softwaremill.okapi:okapi-postgres") implementation("com.softwaremill.okapi:okapi-http") diff --git a/UPGRADING.md b/UPGRADING.md index 2a6cdb40..f74fb166 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -145,6 +145,34 @@ batch per worker per tick, as in 1.x. calls `copy(...)` or a constructor relying on default arguments must be recompiled, or it fails with `NoSuchMethodError`. +### Route-aware claiming: `RouteAwareOutboxStore` and migration `002` (#120) + +The processor now claims only the delivery types it has a deliverer for. + +- **Schema.** Changeset `002__route_aware_claim_index` adds a claim index. The bundled Liquibase + changelogs apply it automatically. If you manage the schema yourself, apply it before starting + 2.0.0 workers: the MySQL claim uses `FORCE INDEX` and fails without it, and the PostgreSQL script + (`CREATE INDEX CONCURRENTLY`) must run outside a transaction. +- **Custom stores.** `OutboxProcessor` requires a `RouteAwareOutboxStore`. A custom `OutboxStore`, + or a hand-written wrapper around a built-in store, must implement it, or `processNext` throws and + Spring autoconfiguration fails at startup while the processor is enabled. +- **Unknown delivery types.** `OutboxEntryProcessor.process`/`processBatch` throw + `IllegalStateException` for an entry with no registered deliverer instead of marking it `FAILED`. + Under `OutboxProcessor` the transaction rolls back and the row stays `PENDING`; direct callers must + handle the exception. + +### `ExposedConnectionProvider` takes a `Database` (#96) + +Pass the `Database` the outbox lives in: `ExposedConnectionProvider(database)`, one instance per +`Database`, as with `ExposedTransactionRunner` and `ExposedTransactionContextValidator`. It now +reads that database's transaction instead of whichever one is innermost on the thread. + +### `OutboxProcessorProperties.transportDispatch` (#113) + +`OutboxProcessorProperties` gained a `transportDispatch` parameter. Java callers and +`application.yml` binding are unaffected; compiled Kotlin code that calls `copy(...)` or a +constructor relying on default arguments must be recompiled, or it fails with `NoSuchMethodError`. + ## From 0.2.x to 1.0.0 Releases up to 0.2.x used the domain table `outbox` and the shared Liquibase tracking diff --git a/gradle.properties b/gradle.properties index 5b491a0a..6b52710a 100644 --- a/gradle.properties +++ b/gradle.properties @@ -7,4 +7,4 @@ org.gradle.caching=true org.gradle.configuration-cache=true GROUP=com.softwaremill.okapi -VERSION_NAME=1.0.0 +VERSION_NAME=2.0.0