Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

package garnet-server as a .NET tool #779

Merged
merged 4 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions main/GarnetServer/GarnetServer.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,29 @@
<PropertyGroup>
<OutputType>Exe</OutputType>
<ServerGarbageCollection>true</ServerGarbageCollection>

<!-- IMPORTANT: Keep the version in sync with .azure\pipelines\azure-pipelines-external-release.yml line ~6. -->
<Version>1.0.36</Version>
<PackageId>garnet-server</PackageId>
<PackAsTool>true</PackAsTool>
<ToolCommandName>garnet-server</ToolCommandName>
<Title>The Microsoft.Garnet RESP server, packaged as a .NET tool</Title>
<GeneratePackageOnBuild Condition="'$(Configuration)'=='Release'">True</GeneratePackageOnBuild>
<Authors>Microsoft</Authors>
<Company>Microsoft</Company>
<RepositoryType>git</RepositoryType>
<RepositoryUrl>https://github.com/microsoft/garnet.git</RepositoryUrl>
<PackageProjectUrl>https://microsoft.github.io/garnet</PackageProjectUrl>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
<Description>
Garnet is a remote cache-store from Microsoft Research, that offers strong performance (throughput and latency),
scalability, storage, recovery, cluster sharding, key migration, and replication features. Garnet uses the Redis RESP wire
protocol and can work with existing Redis clients.
</Description>
<PackageReleaseNotes>See https://github.com/microsoft/garnet for details.</PackageReleaseNotes>
badrishc marked this conversation as resolved.
Show resolved Hide resolved
<Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
<Tags>Garnet key-value store cache dictionary hashtable concurrent persistent remote cluster Redis RESP</Tags>
</PropertyGroup>

<ItemGroup>
Expand All @@ -21,6 +44,10 @@
<None Update="garnet.conf">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="readme.md" Pack="true" PackagePath="/" />
</ItemGroup>

<PropertyGroup>
<PackageReadmeFile>readme.md</PackageReadmeFile>
</PropertyGroup>
</Project>
9 changes: 9 additions & 0 deletions main/GarnetServer/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# garnet-server

`garnet-server` is a .NET global tool that provides the [`Microsoft.Garnet`](https://www.nuget.org/packages/Microsoft.Garnet) RESP server.

The `garnet-server` by itself will create a Garnet server using the default port; for full options, see `garnet-server --help`.


- [Full Garnet documentation](https://microsoft.github.io/garnet/)
- [Garnet GitHub repository](https://github.com/microsoft/garnet.git)
10 changes: 10 additions & 0 deletions website/docs/welcome/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ title: Releases

Find releases at [https://github.com/microsoft/garnet/releases](https://github.com/microsoft/garnet/releases).

## .NET Tool

Garnet can be installed as a [.NET tool](https://aka.ms/global-tools):

``` txt
> dotnet tool install --global garnet-server
>
> garnet-server
badrishc marked this conversation as resolved.
Show resolved Hide resolved
```

## NuGet

Find releases at [https://www.nuget.org/packages/Microsoft.Garnet](https://www.nuget.org/packages/Microsoft.Garnet). The NuGet
Expand Down