From d261fbde1c9b2b0b3149a80315772304657e60a6 Mon Sep 17 00:00:00 2001 From: Mikita Hradovich Date: Fri, 5 Jun 2026 16:34:29 +0200 Subject: [PATCH] docs: deprecate Java Driver 3.x and announce maintenance mode Mark Java Driver 3.x as deprecated per DRIVER-632: - Add deprecation notice to README.md with link to 4.x - Update Maven dependency version references to 3.11.5.15 - Add 3.x branches to DEPRECATED_VERSIONS in Sphinx conf.py - Add deprecation warning banner to docs notice template - Add deprecation entry to changelog The driver enters maintenance mode with only critical bug fixes. Users should migrate to Java Driver 4.x. --- README.md | 16 +++++++++++----- changelog/README.md | 5 +++++ docs/source/_templates/notice.html | 5 +++++ docs/source/conf.py | 7 ++++++- 4 files changed, 27 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5ea20557f82..7343ebd395a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,18 @@ # Scylla Java Driver for Scylla and Apache Cassandra® +> **Deprecation Notice:** Scylla Java Driver 3.x is now **deprecated** and has +> entered **maintenance mode**. Only critical bug fixes will be accepted. +> For new projects and active development, please migrate to +> [Scylla Java Driver 4.x](https://github.com/scylladb/java-driver/tree/scylla-4.x) +> ([documentation](https://java-driver.docs.scylladb.com/stable/)). + *If you're reading this on github.com, please note that this is the readme for the development version and that some features described here might not yet have been released. You can find the documentation for the latest version through the [Java driver docs](https://docs.scylladb.com/using-scylla/scylla-java-driver/) or via the release tags, [e.g. -3.11.5.0](https://github.com/scylladb/java-driver/releases/tag/3.11.5.0).* +3.11.5.15](https://github.com/scylladb/java-driver/releases/tag/3.11.5.15).* A modern, [feature-rich](manual/) and highly tunable Java client library for Apache Cassandra (2.1+) and using exclusively Cassandra's binary protocol @@ -73,7 +79,7 @@ it in your application using the following Maven dependency com.scylladb scylla-driver-core - 3.11.5.0 + 3.11.5.15 ``` @@ -83,7 +89,7 @@ Note that the object mapper is published as a separate artifact: com.scylladb scylla-driver-mapping - 3.11.5.0 + 3.11.5.15 ``` @@ -93,7 +99,7 @@ The 'extras' module is also published as a separate artifact: com.scylladb scylla-driver-extras - 3.11.5.0 + 3.11.5.15 ``` @@ -107,7 +113,7 @@ by running `dnf -y install libxcrypt-compat` ## Compatibility -The Java client driver 3.11.5.0 ([branch scylla-3.x](https://github.com/scylladb/java-driver/tree/scylla-3.x)) is compatible with +The Java client driver 3.11.5.15 ([branch scylla-3.x](https://github.com/scylladb/java-driver/tree/scylla-3.x)) is compatible with Scylla and Apache Cassandra 2.1, 2.2, 3.0+. UDT and tuple support is available only when using Apache Cassandra 2.1 or higher. diff --git a/changelog/README.md b/changelog/README.md index 230a894e963..1d9582b5518 100644 --- a/changelog/README.md +++ b/changelog/README.md @@ -5,6 +5,11 @@ 3.x versions get published. --> +### Deprecation Notice +- [notice] DRIVER-632: Java Driver 3.x is now deprecated and in maintenance mode. Only critical + bug fixes will be accepted. For new projects and active development, please migrate to + [Java Driver 4.x](https://java-driver.docs.scylladb.com/stable/). + ### 3.11.5 - [improvement] JAVA-3114: Shade io.dropwizard.metrics:metrics-core in shaded driver - [improvement] JAVA-3115: SchemaChangeListener#onKeyspaceChanged can fire when keyspace has not changed if using SimpleStrategy replication diff --git a/docs/source/_templates/notice.html b/docs/source/_templates/notice.html index c65ea8d802c..21ea9191450 100644 --- a/docs/source/_templates/notice.html +++ b/docs/source/_templates/notice.html @@ -1,3 +1,8 @@ +
+

Deprecation Notice: ScyllaDB Java Driver 3.x is deprecated and in maintenance mode. + Only critical bug fixes will be accepted. Please migrate to + ScyllaDB Java Driver 4.x.

+

ScyllaDB Java Driver is available under the Apache v2 License. ScyllaDB Java Driver is a fork of DataStax Java Driver. diff --git a/docs/source/conf.py b/docs/source/conf.py index 84e783d2419..09e59b9ed1d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -29,7 +29,12 @@ # Set which versions are not released yet. UNSTABLE_VERSIONS = [] # Set which versions are deprecated -DEPRECATED_VERSIONS = [] +DEPRECATED_VERSIONS = [ + 'scylla-3.7.2.x', + 'scylla-3.10.2.x', + 'scylla-3.11.0.x', + 'scylla-3.11.2.x', +] # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom