redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-06 02:15:48 +03:00
Code Activity

add .release-it.json files, update some md files

Browse Source
This commit is contained in:
leibale
2021-11-15 16:42:34 -05:00
parent 571468e00b
commit 3979e30222
6 changed files with 32 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
.github/README.md vendored
View File

@@ -9,12 +9,6 @@
<a href="https://codecov.io/gh/redis/node-redis" > <a href="https://codecov.io/gh/redis/node-redis" >
<img src="https://codecov.io/gh/redis/node-redis/branch/master/graph/badge.svg?token=xcfqHhJC37" alt="Coverage"/> <img src="https://codecov.io/gh/redis/node-redis/branch/master/graph/badge.svg?token=xcfqHhJC37" alt="Coverage"/>
</a> </a>
<a href="https://www.npmjs.com/package/redis/v/next">
<img src="https://img.shields.io/npm/dm/redis.svg" alt="Downloads"/>
</a>
<a href="https://www.npmjs.com/package/redis/v/next">
<img src="https://img.shields.io/npm/v/redis/next.svg" alt="Version"/>
</a>
<a href="https://discord.gg/XMMVgxUm"> <a href="https://discord.gg/XMMVgxUm">
<img src="https://img.shields.io/discord/697882427875393627" alt="Chat"/> <img src="https://img.shields.io/discord/697882427875393627" alt="Chat"/>
</a> </a>
@@ -28,7 +22,7 @@
npm install redis@next npm install redis@next
``` ```
> :warning: The new interface is clean and cool, but if you have an existing code base, you'll want to read the [migration guide](./docs/v3-to-v4.md). > :warning: The new interface is clean and cool, but if you have an existing code base, you'll want to read the [migration guide](../docs/v3-to-v4.md).
## Usage ## Usage
@@ -57,7 +51,7 @@ createClient({
}); });
``` ```
You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in the [client configuration guide](./docs/client-configuration.md). You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in the [client configuration guide](../docs/client-configuration.md).
### Redis Commands ### Redis Commands
@@ -115,7 +109,7 @@ const [setKeyReply, otherKeyValue] = await client
You can also [watch](https://redis.io/topics/transactions#optimistic-locking-using-check-and-set) keys by calling `.watch()`. Your transaction will abort if any of the watched keys change. You can also [watch](https://redis.io/topics/transactions#optimistic-locking-using-check-and-set) keys by calling `.watch()`. Your transaction will abort if any of the watched keys change.
To dig deeper into transactions, check out the [Isolated Execution Guide](./docs/isolated-execution.md). To dig deeper into transactions, check out the [Isolated Execution Guide](../docs/isolated-execution.md).
### Blocking Commands ### Blocking Commands
@@ -133,7 +127,7 @@ await client.lPush('key', ['1', '2']);
await blPopPromise; // '2' await blPopPromise; // '2'
``` ```
To learn more about isolated execution, check out the [guide](./docs/isolated-execution.md). To learn more about isolated execution, check out the [guide](../docs/isolated-execution.md).
### Pub/Sub ### Pub/Sub
@@ -278,7 +272,7 @@ await Promise.all([
### Clustering ### Clustering
Check out the [Clustering Guide](./docs/clustering.md) when using Node Redis to connect to a Redis Cluster. Check out the [Clustering Guide](../docs/clustering.md) when using Node Redis to connect to a Redis Cluster.
## Supported Redis versions ## Supported Redis versions
@@ -295,12 +289,12 @@ Node Redis is supported with the following versions of Redis:
## Packages ## Packages
| Name | Description | | Name | Description |
|------------------------------------|------------------------------------------------------------| |-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [redis](./packages/all-in-one) | | | [redis](../) | [![Downloads](https://img.shields.io/npm/dm/redis.svg)](https://www.npmjs.com/package/redis/v/next) [![Version](https://img.shields.io/npm/v/redis/next.svg)](https://www.npmjs.com/package/redis/v/next) |
| [@redis/client](./packages/client) | | | [@redis/client](../packages/client) | [![Downloads](https://img.shields.io/npm/dm/@redis/client.svg)](https://www.npmjs.com/package/@redis/client/v/next) [![Version](https://img.shields.io/npm/v/@redis/client/next.svg)](https://www.npmjs.com/package/@redis/client/v/next) |
| [@redis/json](./packages/json) | [Redis JSON](https://oss.redis.com/redisjson/) commands | | [@redis/json](../packages/json) | [![Downloads](https://img.shields.io/npm/dm/@redis/json.svg)](https://www.npmjs.com/package/@redis/json/v/next) [![Version](https://img.shields.io/npm/v/@redis/json/next.svg)](https://www.npmjs.com/package/@redis/json/v/next) [Redis JSON](https://oss.redis.com/redisjson/) commands |
| [@redis/search](./packages/search) | [Redis Search](https://oss.redis.com/redisearch/) commands | | [@redis/search](../packages/search) | [![Downloads](https://img.shields.io/npm/dm/@redis/search.svg)](https://www.npmjs.com/package/@redis/search/v/next) [![Version](https://img.shields.io/npm/v/@redis/search/next.svg)](https://www.npmjs.com/package/@redis/search/v/next) [Redis Search](https://oss.redis.com/redisearch/) commands |
## Contributing ## Contributing

5
.release-it.json Normal file
View File

@@ -0,0 +1,5 @@
{
"git": {
"tagName": "redis@${version}"
}
}

2
docs/client-configuration.md
View File

@@ -15,7 +15,7 @@
| username | | ACL username ([see ACL guide](https://redis.io/topics/acl)) | | username | | ACL username ([see ACL guide](https://redis.io/topics/acl)) |
| password | | ACL password or the old "--requirepass" password | | password | | ACL password or the old "--requirepass" password |
| database | | Database number to connect to (see [`SELECT`](https://redis.io/commands/select) command) | | database | | Database number to connect to (see [`SELECT`](https://redis.io/commands/select) command) |
| modules | | Object defining which [Redis Modules](../../README.md#modules) to include | | modules | | Object defining which [Redis Modules](../.github/README.md#packages) to include |
| scripts | | Object defining Lua Scripts to use with this client (see [Lua Scripts](../README.md#lua-scripts)) | | scripts | | Object defining Lua Scripts to use with this client (see [Lua Scripts](../README.md#lua-scripts)) |
| commandsQueueMaxLength | | Maximum length of the client's internal command queue | | commandsQueueMaxLength | | Maximum length of the client's internal command queue |
| readonly | `false` | Connect in [`READONLY`](https://redis.io/commands/readonly) mode | | readonly | `false` | Connect in [`READONLY`](https://redis.io/commands/readonly) mode |

5
packages/client/.release-it.json Normal file
View File

@@ -0,0 +1,5 @@
{
"git": {
"tagName": "client@${version}"
}
}

5
packages/json/.release-it.json Normal file
View File

@@ -0,0 +1,5 @@
{
"git": {
"tagName": "json@${version}"
}
}

5
packages/search/.release-it.json Normal file
View File

@@ -0,0 +1,5 @@
{
"git": {
"tagName": "search@${version}"
}
}