Merge branch 'master' into DOC-4733-geo-index-examples

Author: atakavci

.github/wordlist.txt

@@ -23,3 +23,4 @@ TimeSeries
 triaging
 www
 yml
+runsettings

.github/workflows/integration.yml

@@ -37,7 +37,7 @@ jobs:
         max-parallel: 15
         fail-fast: false
         matrix:
-          redis-version: [ '8.0-M02', '8.0-M03', '${{ needs.redis_version.outputs.CURRENT }}', '7.2.6', '6.2.16']
+          redis-version: [ '8.0-M04-pre', '${{ needs.redis_version.outputs.CURRENT }}', '7.2.6', '6.2.16']
           dotnet-version: ['6.0', '7.0', '8.0']
       env:
         ACTIONS_ALLOW_UNSECURE_COMMANDS: true

.github/workflows/nuget-release.yml

@@ -19,6 +19,25 @@ jobs:
         run: dotnet --list-sdks
       - name: Check .NET runtimes
         run: dotnet --list-runtimes
+
+      - name: get version from tag
+        id: get_version
+        run: |
+          realversion="${GITHUB_REF/refs\/tags\//}"
+          realversion="${realversion//v/}"
+          echo "VERSION=$realversion" >> $GITHUB_OUTPUT
+
+      - name: Update version in csproj
+        run: |
+          VERSION=${{ steps.get_version.outputs.VERSION }}
+          echo "Setting version to $VERSION"
+
+          # Update the version in the NRedisStack.csproj file
+          sed -i "s|<Version>.*</Version>|<Version>$VERSION</Version>|" ./src/NRedisStack/NRedisStack.csproj
+          sed -i "s|<ReleaseVersion>.*</ReleaseVersion>|<ReleaseVersion>$VERSION</ReleaseVersion>|" ./src/NRedisStack/NRedisStack.csproj
+          sed -i "s|<PackageVersion>.*</PackageVersion>|<PackageVersion>$VERSION</PackageVersion>|" ./src/NRedisStack/NRedisStack.csproj        
+          cat ./src/NRedisStack/NRedisStack.csproj    
+
       - name: Build
         run: dotnet pack -c Release --output .
       - name: Publish

.gitignore

@@ -382,6 +382,7 @@ FodyWeavers.xsd
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
+!.vscode/.runsettings
 *.code-workspace
 
 # Local History for Visual Studio Code

.vscode/.runsettings

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- File name extension must be .runsettings -->
+<RunSettings>
+  <RunConfiguration>
+    <EnvironmentVariables>
+      <!-- List of environment variables we want to set-->
+      <REDIS_VERSION>7.4.0</REDIS_VERSION>
+    </EnvironmentVariables>
+  </RunConfiguration>
+</RunSettings>

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
     "dotnet-test-explorer.testArguments": "/p:CollectCoverage=true /p:CoverletOutputFormat=lcov /p:CoverletOutput=./lcov.info",
     "dotnet-test-explorer.testProjectPath": "**/*NRedisStack.Tests.csproj",
-    "dotnet.defaultSolution": "NRedisStack.sln"
+    "dotnet.defaultSolution": "NRedisStack.sln",
+    "dotnet.unitTests.runSettingsPath": ".vscode/.runsettings"
 }

CONTRIBUTING.md

@@ -113,6 +113,19 @@ e.g:
 dotnet test --environment="REDIS=127.17.0.1:6379"
 ```
 
+Most of the integration tests rely on specific server capabilities,
+so, to be able run matching test cases properly you will need to set `REDIS_VERSION` variable with your actual server version that tests running against.
+```bash
+dotnet test --environment="REDIS=<redisServer:port>" --environment="REDIS_VERSION=<redisServerVersion>"
+```
+e.g:
+```bash
+dotnet test --environment="REDIS=127.17.0.1:6379" --environment="REDIS_VERSION=7.4.0"
+```
+
+If you are relying on an IDE to run the tests, then you can set these parameters in [.runsettings](.vscode/.runsettings) file. 
+You also need to check if your IDE supports [settings.json](.vscode/settings.json) for this to work.
+
 To run your tests against an oss cluster:
 ```bash
 dotnet test --environment "REDIS_CLUSTER=<redisServer:port>" --environment "NUM_REDIS_CLUSTER_NODES=<number of nodes in the cluster>"

README.md

@@ -41,6 +41,7 @@ Each module has a command class with its own commands.
 The supported modules are [Search](https://redis.io/commands/?group=search), [JSON](https://redis.io/commands/?group=json), [TimeSeries](https://redis.io/commands/?group=timeseries), [Bloom Filter](https://redis.io/commands/?group=bf), [Cuckoo Filter](https://redis.io/commands/?group=cf), [T-Digest](https://redis.io/commands/?group=tdigest), [Count-min Sketch](https://redis.io/commands/?group=cms), and [Top-K](https://redis.io/commands/?group=topk).
 
 **Note:** RedisGraph support has been deprecated starting from Redis Stack version 7.2. For more information, please refer to [this blog post](https://redis.com/blog/redisgraph-eol/).
+**IMPORTANT:** NRedisStack will end the support for Graph functionalities with version 0.13.x  
 
 # Usage
 
@@ -87,7 +88,7 @@ TdigestCommands tdigest = db.TDIGEST();
 SearchCommands ft = db.FT();
 JsonCommands json = db.JSON();
 TimeSeriesCommands ts = db.TS();
-GraphCommands graph = db.GRAPH(); // If Redis version is less than 7.2
+GraphCommands graph = db.GRAPH(); // If Redis version is less than 7.2 and NRedisStack version is less than 0.13.x
 ```
 Then, that variable will allow you to call all the commands of that module.
 
@@ -154,9 +155,12 @@ ft.DropIndex("myIndex");
 
 More examples can be found in the [examples folder](Examples).
 
+## For Contributors
+To contribute NRedisStack, please see :point_right: [Contribution notes](CONTRIBUTING.md)
+
 ------
 
-### Author
+# Author
 
 NRedisStack is developed and maintained by [Redis Inc](https://redis.com). It can be found [here](
 https://github.com/redis/NRedisStack), or downloaded from [NuGet](https://www.nuget.org/packages/NRedisStack).