diff --git a/.github/workflows/java-cd.yml b/.github/workflows/java-cd.yml index 9dcaa8c4e9..5faad09b85 100644 --- a/.github/workflows/java-cd.yml +++ b/.github/workflows/java-cd.yml @@ -13,7 +13,7 @@ on: workflow_dispatch: inputs: version: - description: 'The release version of GLIDE, formatted as v*.*.* or v*.*.*-rc*' + description: 'The release version of GLIDE, formatted as *.*.* or *.*.*-rc*' required: true concurrency: diff --git a/.github/workflows/npm-cd.yml b/.github/workflows/npm-cd.yml index 4031ada90f..25db537ab5 100644 --- a/.github/workflows/npm-cd.yml +++ b/.github/workflows/npm-cd.yml @@ -18,7 +18,7 @@ on: workflow_dispatch: inputs: version: - description: 'The release version of GLIDE, formatted as v*.*.* or v*.*.*-rc*' + description: 'The release version of GLIDE, formatted as *.*.* or *.*.*-rc*' required: true concurrency: @@ -34,9 +34,6 @@ jobs: runs-on: ubuntu-latest environment: AWS_ACTIONS steps: - - run: echo $OWNER - env: - OWNER: ${{ github.repository_owner }} - name: Checkout uses: actions/checkout@v4 with: diff --git a/.github/workflows/pypi-cd.yml b/.github/workflows/pypi-cd.yml index bcbcbf108f..b45992e6e7 100644 --- a/.github/workflows/pypi-cd.yml +++ b/.github/workflows/pypi-cd.yml @@ -17,7 +17,7 @@ on: workflow_dispatch: inputs: version: - description: 'The release version of GLIDE, formatted as v*.*.* or v*.*.*-rc*' + description: 'The release version of GLIDE, formatted as *.*.* or *.*.*-rc*' required: true concurrency: diff --git a/README.md b/README.md index f440fbf329..57217f0d6b 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,11 @@ Valkey GLIDE is API-compatible with the following engine versions: | Engine Type | 6.2 | 7.0 | 7.2 | |-----------------------|-------|-------|-------| -| Valkey | V | V | V | +| Valkey | - | - | V | | Redis | V | V | V | ## Current Status -In this release, Valkey GLIDE is available for Python and Java. Support for Node.js is actively under development, with plans to include more programming languages in the future. We're tracking future features on the [roadmap](https://github.com/orgs/aws/projects/187/). +In this release, Valkey GLIDE is available for Python and Java. Support for Node.js is actively under development, with plans to include more programming languages in the future. We're tracking future features on the [roadmap](https://github.com/orgs/valkey-io/projects/5). ## Getting Started - [Java](./java/README.md) diff --git a/csharp/README.md b/csharp/README.md index 56bb300463..390b146adc 100644 --- a/csharp/README.md +++ b/csharp/README.md @@ -1,6 +1,6 @@ # C# wrapper -The C# wrapper is currently not in a usable state. +The C# wrapper is currently not in a usable state and is under development. # Valkey GLIDE @@ -12,7 +12,7 @@ Refer to the [Supported Engine Versions table](https://github.com/valkey-io/valk ## Current Status -We've made GLIDE for Redis an open-source project, and are releasing it in Preview to the community to gather feedback, and actively collaborate on the project roadmap. We welcome questions and contributions from all Redis stakeholders. +We've made Valkey GLIDE an open-source project, and are releasing it in Preview to the community to gather feedback, and actively collaborate on the project roadmap. We welcome questions and contributions from all Redis stakeholders. This preview release is recommended for testing purposes only. # Getting Started - C# Wrapper diff --git a/go/README.md b/go/README.md new file mode 100644 index 0000000000..cbab727b42 --- /dev/null +++ b/go/README.md @@ -0,0 +1,23 @@ +# GO wrapper + +The GO wrapper is currently not in a usable state and is under development. + +# Valkey GLIDE + +Valkey General Language Independent Driver for the Enterprise (GLIDE), is an open-source Valkey client library. Valkey GLIDE is one of the official client libraries for Valkey, and it supports all Valkey commands. Valkey GLIDE supports Valkey 7.2 and above, and Redis open-source 6.2, 7.0 and 7.2. Application programmers use Valkey GLIDE to safely and reliably connect their applications to Valkey- and Redis OSS- compatible services. Valkey GLIDE is designed for reliability, optimized performance, and high-availability, for Valkey and Redis OSS based applications. It is sponsored and supported by AWS, and is pre-configured with best practices learned from over a decade of operating Redis OSS-compatible services used by hundreds of thousands of customers. To help ensure consistency in application development and operations, Valkey GLIDE is implemented using a core driver framework, written in Rust, with language specific extensions. This design ensures consistency in features across languages and reduces overall complexity. + +## Supported Engine Versions + +Refer to the [Supported Engine Versions table](https://github.com/valkey-io/valkey-glide/blob/main/README.md#supported-engine-versions) for details. + +## Current Status + +# Getting Started - GO Wrapper + +## GO supported version + +## Basic Example + +### Building & Testing + +Development instructions for local building & testing the package are in the [DEVELOPER.md](DEVELOPER.md) file. diff --git a/java/.gitignore b/java/.gitignore index be32d08fc9..0c5c26d954 100644 --- a/java/.gitignore +++ b/java/.gitignore @@ -9,3 +9,6 @@ protobuf # Must be ignored as part of Maven Central publishing process gradle.properties + +# Ignore VSCode JUnit extension directories +bin/ diff --git a/java/DEVELOPER.md b/java/DEVELOPER.md index c0613b10a8..91a6b39793 100644 --- a/java/DEVELOPER.md +++ b/java/DEVELOPER.md @@ -77,7 +77,7 @@ Before starting this step, make sure you've installed all software dependencies. ```bash VERSION=0.1.0 # You can modify this to other released version or set it to "main" to get the unstable branch git clone --branch ${VERSION} https://github.com/valkey-io/valkey-glide.git - cd glide-for-redis/java + cd valkey-glide/java ``` 2. Initialize git submodule: ```bash diff --git a/java/client/build.gradle b/java/client/build.gradle index 165ca30133..526dff0b06 100644 --- a/java/client/build.gradle +++ b/java/client/build.gradle @@ -236,7 +236,7 @@ tasks.withType(Test) { } jar { - archiveBaseName = "glide-for-redis" + archiveBaseName = "valkey-glide" // placeholder will be renamed by platform+arch on the release workflow java-cd.yml archiveClassifier = "placeholder" } diff --git a/node/README.md b/node/README.md index 1e40e6efc4..6d98b6a856 100644 --- a/node/README.md +++ b/node/README.md @@ -15,74 +15,12 @@ This preview release is recommended for testing purposes only. ## System Requirements -The beta release of Valkey GLIDE was tested on Intel x86_64 using Ubuntu 22.04.1, Amazon Linux 2023 (AL2023), and macOS 12.7. +In this release, Valkey GLIDE is available for Python and Java. Support for Node.js is actively under development, with plans to include more programming languages in the future. We're tracking future features on the [roadmap](https://github.com/orgs/aws/projects/187/). ## NodeJS supported version Node.js 16.20 or higher. -## Installation and Setup - -### Installing via Package Manager (npm) - -To install GLIDE for Redis using `npm`, follow these steps: - -1. Open your terminal. -2. Execute the command below: - ```bash - $ npm install @aws/glide-for-redis - ``` -3. After installation, confirm the client is installed by running: - ```bash - $ npm list - myApp@ /home/ubuntu/myApp - └── @aws/glide-for-redis@0.1.0 - ``` - -## Basic Examples - -#### Cluster Redis: - -```node -import { GlideClusterClient } from "@aws/glide-for-redis"; - -const addresses = [ - { - host: "redis.example.com", - port: 6379, - }, -]; -const client = await GlideClusterClient.createClient({ - addresses: addresses, -}); -await client.set("foo", "bar"); -const value = await client.get("foo"); -client.close(); -``` - -#### Standalone Redis: - -```node -import { GlideClient } from "@aws/glide-for-redis"; - -const addresses = [ - { - host: "redis_primary.example.com", - port: 6379, - }, - { - host: "redis_replica.example.com", - port: 6379, - }, -]; -const client = await GlideClient.createClient({ - addresses: addresses, -}); -await client.set("foo", "bar"); -const value = await client.get("foo"); -client.close(); -``` - ## Documentation Visit our [wiki](https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper) for examples and further details on TLS, Read strategy, Timeouts and various other configurations. diff --git a/submodules/redis-rs b/submodules/redis-rs index ca36bd4b93..ee3119d17d 160000 --- a/submodules/redis-rs +++ b/submodules/redis-rs @@ -1 +1 @@ -Subproject commit ca36bd4b9311e9ff97639d7a2d54f315a3884486 +Subproject commit ee3119d17dfafc57aba154be991efaccbe2833f9