Skip to content

Commit

Permalink
Fix Node & Python renaming to valkey-glide (#1879)
Browse files Browse the repository at this point in the history
Signed-off-by: GilboaAWS <[email protected]>
  • Loading branch information
barshaul authored and GilboaAWS committed Jul 9, 2024
1 parent d1f7954 commit 479e376
Show file tree
Hide file tree
Showing 10 changed files with 39 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/node-create-package-file/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ runs:
# echo -musl if inputs.target is musl
export MUSL_FLAG=`if [[ "${{ inputs.target }}" =~ .*"musl".* ]]; then echo "-musl"; fi`
# set the package name
name="glide-for-redis"
name="valkey-glide"
# derive the OS and architecture from the inputs
export node_os="${{ inputs.named_os }}"
export node_arch="${{ inputs.arch }}"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/npm-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ jobs:
shell: bash
working-directory: ./node/npm/glide
run: |
export pkg_name=glide-for-redis
export pkg_name=valkey-glide
echo "${GITHUB_REF:11}"
export package_version=${GITHUB_REF:11}
export scope=`if [ "$NPM_SCOPE" != '' ]; then echo "$NPM_SCOPE/"; fi`
Expand Down Expand Up @@ -361,7 +361,7 @@ jobs:
working-directory: ./utils/release-candidate-testing/node
run: |
npm install
npm install --no-save @aws/glide-for-redis@${{ env.NPM_TAG }}
npm install --no-save @valkey/valkey-glide@${{ env.NPM_TAG }}
npm run test
# Reset the repository to make sure we get the clean checkout of the action later in other actions.
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ort.yml
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ jobs:
run: |
# Remove the glide-rs dependency to avoid duplication
sed -i '/ "glide-rs":/d' ../../package.json
export pkg_name=glide-for-redis-base
export pkg_name=valkey-glide-base
export package_version="${{ env.RELEASE_VERSION }}"
export scope=`if [ "$NPM_SCOPE" != '' ]; then echo "$NPM_SCOPE/"; fi`
mv package.json package.json.tmpl
Expand Down Expand Up @@ -203,7 +203,7 @@ jobs:
run: |
export BRANCH_NAME=`if [ "$EVENT_NAME" == 'schedule' ] || [ "$EVENT_NAME" == 'pull_request' ]; then echo 'scheduled-ort'; else echo "ort-v$INPUT_VERSION"; fi`
echo "Creating pull request from branch ${BRANCH_NAME} to branch ${{ env.BASE_BRANCH }}"
git config --global user.email "[email protected]"
git config --global user.email "[email protected]"
git config --global user.name "ort-bot"
git checkout -b ${BRANCH_NAME}
git add $PYTHON_ATTRIBUTIONS $NODE_ATTRIBUTIONS $RUST_ATTRIBUTIONS $JAVA_ATTRIBUTIONS
Expand Down
2 changes: 1 addition & 1 deletion benchmarks/node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"@types/command-line-args": "^5.2.0",
"@types/stats-lite": "^2.2.0",
"command-line-args": "^5.2.1",
"glide-for-redis": "file:../../node",
"valkey-glide": "file:../../node",
"ioredis": "5.3.2",
"percentile": "^1.6.0",
"redis": "4.6.13",
Expand Down
9 changes: 2 additions & 7 deletions csharp/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# C# wrapper
# C# wrapper - Current Status

The C# wrapper is currently not in a usable state.
The C# wrapper is currently not in a usable state and is under development.

# GLIDE for Redis

Expand All @@ -11,11 +11,6 @@ Strategic, mission-critical Redis-based applications have requirements for secur

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

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.
This preview release is recommended for testing purposes only.

# Getting Started - C# Wrapper

## .net sdk supported version
Expand Down
6 changes: 3 additions & 3 deletions examples/node/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,19 @@ npm i -g npm@8
## Build
To build GLIDE's Node client, run (on unix based systems):
```
cd glide-for-redis/node
cd valkey-glide/node
git submodule update --init --recursive
npm install
rm -rf build-ts
npm run build:release
cd glide-for-redis/examples/node
cd valkey-glide/examples/node
npm install
npx tsc
```

## Run
To run the example:
```
cd glide-for-redis/examples/node
cd valkey-glide/examples/node
node index.js
```
2 changes: 1 addition & 1 deletion examples/node/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"type": "module",
"dependencies": {
"@aws/glide-for-redis": "^0.1.0",
"@valkey/valkey-glide": "^1.0.0",
"@types/node": "^20.4.8"
},
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion examples/python/requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
glide-for-redis>=0.1
valkey-glide
22 changes: 22 additions & 0 deletions go/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# GO wrapper - Current Status

The GO wrapper is currently not in a usable state and is under development.

# GLIDE for Redis

General Language Independent Driver for the Enterprise (GLIDE) for Redis, is an AWS-sponsored, open-source Redis client. GLIDE for Redis works with any Redis distribution that adheres to the Redis Serialization Protocol (RESP) specification, including open-source Redis, Amazon ElastiCache for Redis, and Amazon MemoryDB for Redis.
Strategic, mission-critical Redis-based applications have requirements for security, optimized performance, minimal downtime, and observability. GLIDE for Redis is designed to provide a client experience that helps meet these objectives. It is sponsored and supported by AWS, and comes pre-configured with best practices learned from over a decade of operating Redis-compatible services used by hundreds of thousands of customers. To help ensure consistency in development and operations, GLIDE for Redis is implemented using a core driver framework, written in Rust, with extensions made available for each supported programming language. This design ensures that updates easily propagate to each language 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.

# 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.
9 changes: 4 additions & 5 deletions node/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Node wrapper - Current Status

The Node wrapper is currently not in a usable state and is under development.

# GLIDE for Redis

General Language Independent Driver for the Enterprise (GLIDE) for Redis, is an AWS-sponsored, open-source Redis client. GLIDE for Redis works with any Redis distribution that adheres to the Redis Serialization Protocol (RESP) specification, including open-source Redis, Amazon ElastiCache for Redis, and Amazon MemoryDB for Redis.
Expand All @@ -7,11 +11,6 @@ Strategic, mission-critical Redis-based applications have requirements for secur

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

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 - Node Wrapper

## System Requirements
Expand Down

0 comments on commit 479e376

Please sign in to comment.