Merge remote-tracking branch 'redis/master' into feature/automatic-failover-2

Author: atakavci

.github/workflows/codeql-analysis.yml

@@ -1,17 +1,7 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
 name: "CodeQL"
 
 on:
+  workflow_dispatch:
   push:
     branches: [ master ]
   pull_request:
@@ -35,29 +25,21 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: java
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+        dependency-caching: true
+        build-mode: manual
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+    - name: Set up JDK 8
+      uses: actions/setup-java@v4
+      with:
+        distribution: temurin
+        java-version: '8'
+        cache: maven
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+    - name: Build
+      run: mvn -B package
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

.github/workflows/doctests.yml

@@ -12,8 +12,8 @@ jobs:
   doctests:
     runs-on: ubuntu-latest
     services:
-      redis-stack:
-        image: redis/redis-stack-server:latest
+      redis:
+        image: redis:latest
         options: >-
           --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
         ports:
@@ -33,6 +33,9 @@ jobs:
         with:
           java-version: '11'
           distribution: 'temurin'
+      - name: Maven offline
+        run: |
+          mvn -q dependency:go-offline
       - name: Run doctests
         run: |
-          mvn -Pdoctests test
+          mvn -Pdoctests clean compile test

.github/workflows/integration.yml

@@ -56,15 +56,3 @@ jobs:
         env:
           JVM_OPTS: -Xmx3200m
           TERM: dumb
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v4
-        with:
-          fail_ci_if_error: false
-          token: ${{ secrets.CODECOV_TOKEN }}
-      - name: Upload test results to Codecov
-        if: ${{ github.event_name == 'schedule' || (github.event_name == 'push') || github.event_name == 'workflow_dispatch'}}
-        uses: codecov/test-results-action@v1
-        with:
-          fail_ci_if_error: false
-          files: ./target/surefire-reports/TEST*
-          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/test-on-docker.yml

@@ -80,9 +80,9 @@ jobs:
           export TEST_WORK_FOLDER=$REDIS_ENV_WORK_DIR
           echo $TEST_WORK_FOLDER
           if [ -z "$TESTS" ]; then
-            mvn clean compile test
+            mvn clean compile verify
           else
-            mvn -Dtest=$TESTS clean compile test
+            mvn -Dtest=$TESTS clean verify
           fi
         env:
           JVM_OPTS: "-XX:+HeapDumpOnOutOfMemoryError -XX:+ExitOnOutOfMemoryError -XX:HeapDumpPath=${{ runner.temp }}/heapdump-${{ matrix.redis_version }}.hprof"
@@ -105,6 +105,7 @@ jobs:
         with:
           files: |
             target/surefire-reports/**/*.xml
+            target/failsafe-reports/**/*.xml
       # Collect logs on failure
       - name: Collect logs on failure
         if: failure()  # This runs only if the previous steps failed
@@ -125,15 +126,22 @@ jobs:
           docker compose $COMPOSE_ENV_FILES -f src/test/resources/env/docker-compose.yml down
         continue-on-error: true
       # Upload code coverage
-      - name: Upload coverage to Codecov
+      - name: Upload merged coverage to Codecov
         uses: codecov/codecov-action@v5
         with:
+          # Upload the merged JaCoCo XML report generated at verify phase
+          files: ./target/site/jacoco/jacoco.xml
+          flags: docker-${{ matrix.redis_version }}
+          name: merged-coverage
           fail_ci_if_error: false
           token: ${{ secrets.CODECOV_TOKEN }}
-      - name: Upload test results to Codecov
+      - name: Upload test results to Codecov (unit + IT)
         if: ${{ github.event_name == 'schedule' || (github.event_name == 'push') || github.event_name == 'workflow_dispatch'}}
         uses: codecov/test-results-action@v1
         with:
           fail_ci_if_error: false
-          files: ./target/surefire-reports/TEST*
+          files: |
+            ./target/surefire-reports/*.xml
+            ./target/failsafe-reports/*.xml
+          flags: test-results-docker-${{ matrix.redis_version }}
           token: ${{ secrets.CODECOV_TOKEN }}

Makefile

@@ -522,10 +522,10 @@ stop:
 test: | start mvn-test-local stop
 
 mvn-test-local:
-	@TEST_ENV_PROVIDER=local mvn -Dtest=${TEST} clean compile test
+	@TEST_ENV_PROVIDER=local mvn -Dtest=${TEST} clean verify
 
 mvn-test:
-	mvn -Dtest=${TEST} clean compile test
+	mvn -Dtest=${TEST} clean verify
 
 package: | start mvn-package stop
 

README.md

@@ -1,10 +1,9 @@
 # Jedis
 
 [![Release](https://img.shields.io/github/release/redis/jedis.svg?sort=semver)](https://github.com/redis/jedis/releases/latest)
-[![Maven Central](https://img.shields.io/maven-central/v/redis.clients/jedis.svg)](https://search.maven.org/artifact/redis.clients/jedis)
+[![Maven Central](https://img.shields.io/maven-central/v/redis.clients/jedis.svg)](https://central.sonatype.com/artifact/redis.clients/jedis)
 [![Javadocs](https://www.javadoc.io/badge/redis.clients/jedis.svg)](https://www.javadoc.io/doc/redis.clients/jedis)
-[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt)
-[![Integration](https://github.com/redis/jedis/actions/workflows/integration.yml/badge.svg?branch=master)](https://github.com/redis/jedis/actions/workflows/integration.yml)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/redis/jedis/blob/master/LICENSE)
 [![codecov](https://codecov.io/gh/redis/jedis/branch/master/graph/badge.svg?token=pAstxAAjYo)](https://codecov.io/gh/redis/jedis)
 [![Discord](https://img.shields.io/discord/697882427875393627?style=flat-square)](https://discord.gg/redis)
 
@@ -29,13 +28,10 @@ Are you looking for a high-level library to handle object mapping? See [redis-om
 ## Supported Redis versions
 
 The most recent version of this library supports redis version 
-[5.0](https://github.com/redis/redis/blob/5.0/00-RELEASENOTES), 
-[6.0](https://github.com/redis/redis/blob/6.0/00-RELEASENOTES), 
-[6.2](https://github.com/redis/redis/blob/6.2/00-RELEASENOTES), 
-[7.0](https://github.com/redis/redis/blob/7.0/00-RELEASENOTES), 
 [7.2](https://github.com/redis/redis/blob/7.2/00-RELEASENOTES),
-[7.4](https://github.com/redis/redis/blob/7.4/00-RELEASENOTES) and
-[8.0](https://github.com/redis/redis/blob/8.0/00-RELEASENOTES).
+[7.4](https://github.com/redis/redis/blob/7.4/00-RELEASENOTES),
+[8.0](https://github.com/redis/redis/blob/8.0/00-RELEASENOTES) and
+[8.2](https://github.com/redis/redis/blob/8.2/00-RELEASENOTES).
 
 The table below highlights version compatibility of the most-recent library versions with Redis and JDK versions. Compatibility means communication features, and Redis command capabilities.
 
@@ -47,6 +43,7 @@ The table below highlights version compatibility of the most-recent library vers
 | >= 5.0        | Version 6.0 to current                | 8, 11, 17, 21     |
 | >= 5.2        | Version 7.2 to current                | 8, 11, 17, 21     |
 | >= 6.0        | Version 7.2 to current                | 8, 11, 17, 21     |
+| >= 7.0        | Version 7.2 to current                | 8, 11, 17, 21     |
 
 ## Getting started
 
@@ -56,16 +53,16 @@ To get started with Jedis, first add it as a dependency in your Java project. If
 <dependency>
     <groupId>redis.clients</groupId>
     <artifactId>jedis</artifactId>
-    <version>6.0.0</version>
+    <version>6.2.0</version>
 </dependency>
 ```
 
-To use the cutting-edge Jedis, check [here](/docs/jedis-maven.md).
+To use the cutting-edge Jedis, check [here](https://redis.github.io/jedis/jedis-maven/).
 
-Next, you'll need to connect to Redis. Consider installing a redis-stack docker:
+Next, you'll need to connect to Redis. Consider installing a redis server with docker:
 
 ```bash
-docker run -p 6379:6379 -it redis/redis-stack:latest
+docker run -p 6379:6379 -it redis:latest
 ```
 
 For many applications, it's best to use a connection pool. You can instantiate a Jedis connection pool like so:
@@ -127,7 +124,7 @@ jedis.sadd("planets", "Mars");
 Jedis includes support for [Redis modules](https://redis.io/docs/modules/) such as
 [RedisJSON](https://redis.io/json/) and [RediSearch](https://redis.io/search/).
 
-See the [RedisJSON Jedis](docs/redisjson.md) or [RediSearch Jedis](docs/redisearch.md) for details.
+See the [RedisJSON Jedis](https://redis.github.io/jedis/redisjson/) or [RediSearch Jedis](https://redis.github.io/jedis/redisearch/) for details.
 
 ## Failover
 
@@ -136,24 +133,24 @@ Jedis supports retry and failover for your Redis deployments. This is useful whe
 1. You have more than one Redis deployment. This might include two independent Redis servers or two or more Redis databases replicated across multiple [active-active Redis Enterprise](https://redis.io/docs/latest/operate/rs/databases/active-active/) clusters.
 2. You want your application to connect to one deployment at a time and to fail over to the next available deployment if the first deployment becomes unavailable.
 
-For the complete failover configuration options and examples, see the [Jedis failover docs](docs/failover.md).
+For the complete failover configuration options and examples, see the [Jedis failover docs](https://redis.github.io/jedis/failover/).
 
 ## Token-Based Authentication
 
 Jedis supports Token-Based authentication (TBA) starting with 5.3.0 GA release. This feature is complemented by an extension library that enhances the developer experience and provides most of the components required for TBA functionality.
 
 Notably, the extension library includes built-in support for **Microsoft EntraID**, offering a seamless integration as part of the generic solution.
 
-For more details and examples, please refer to the [Advanced Usage](docs/advanced-usage.md) documentation.
+For more details and examples, please refer to the [Advanced Usage](https://redis.github.io/jedis/advanced-usage/) documentation.
 
 ## Documentation
 
-The [Jedis wiki](http://github.com/redis/jedis/wiki) contains several useful articles for using Jedis.
+The [Jedis documentation site](https://redis.github.io/jedis/) contains several useful articles for using Jedis.
 
 You can also check the [latest Jedis Javadocs](https://www.javadoc.io/doc/redis.clients/jedis/latest/index.html).
 
 Some specific use-case examples can be found in [`redis.clients.jedis.examples`
-package](src/test/java/redis/clients/jedis/examples/) of the test source codes.
+package](https://github.com/redis/jedis/tree/master/src/test/java/redis/clients/jedis/examples/) of the test source codes.
 
 ## Troubleshooting
 
@@ -178,4 +175,4 @@ Jedis is licensed under the [MIT license](https://github.com/redis/jedis/blob/ma
 
 ## Sponsorship
 
-[![Redis Logo](redis-logo-full-color-rgb.png)](https://redis.io/)
+[![Redis Logo](https://raw.githubusercontent.com/redis/jedis/master/redis-logo-full-color-rgb.png)](https://redis.io/)

docs/jedis-maven.md

@@ -6,29 +6,35 @@
 <dependency>
     <groupId>redis.clients</groupId>
     <artifactId>jedis</artifactId>
-    <version>6.0.0</version>
+    <version>6.2.0</version>
 </dependency>
 ```
 
 ### Snapshots
 
 ```xml
-  <repositories>
+<repositories>
     <repository>
-      <id>snapshots-repo</id>
-      <url>https://oss.sonatype.org/content/repositories/snapshots</url>
+        <id>sonatype-snapshots</id>
+        <url>https://oss.sonatype.org/content/repositories/snapshots</url>
+        <releases>
+            <enabled>false</enabled>
+        </releases>
+        <snapshots>
+            <enabled>true</enabled>
+        </snapshots>
     </repository>
-  </repositories>
+</repositories>
 ```
 
 and
 
 ```xml
-  <dependencies>
+<dependencies>
     <dependency>
-      <groupId>redis.clients</groupId>
-      <artifactId>jedis</artifactId>
-      <version>6.1.0-SNAPSHOT</version>
+        <groupId>redis.clients</groupId>
+        <artifactId>jedis</artifactId>
+        <version>7.0.0-SNAPSHOT</version>
     </dependency>
-  </dependencies>
+</dependencies>
 ```

mkdocs.yml

@@ -19,6 +19,7 @@ plugins:
 
 nav:
   - Home: index.md
+  - Jedis Maven: jedis-maven.md
   - Migrating to newer versions:
       - Jedis 5: breaking-5.md
       - Jedis 4:
@@ -35,4 +36,5 @@ nav:
   - Tutorials and Examples:  tutorials_examples.md
   - Jedis Guide: https://redis.io/docs/latest/develop/connect/clients/java/jedis/
   - Redis Command Reference: https://redis.io/docs/latest/commands/
+  - Advanced Usage: advanced-usage.md