package garnet-server as a .NET tool (#779)

* package garnet-server as a .NET tool * docs --------- Co-authored-by: Badrish Chandramouli <[email protected]>
microsoft · Nov 8, 2024 · 8149574 · 8149574
1 parent d3717ad
commit 8149574
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 0 deletions.
diff --git a/main/GarnetServer/GarnetServer.csproj b/main/GarnetServer/GarnetServer.csproj
@@ -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>
+    <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
+    <Tags>Garnet key-value store cache dictionary hashtable concurrent persistent remote cluster Redis RESP</Tags>
   </PropertyGroup>
 
   <ItemGroup>
@@ -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>
diff --git a/main/GarnetServer/readme.md b/main/GarnetServer/readme.md
@@ -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)
diff --git a/website/docs/welcome/releases.md b/website/docs/welcome/releases.md
@@ -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
+```
+
 ## NuGet
 
 Find releases at [https://www.nuget.org/packages/Microsoft.Garnet](https://www.nuget.org/packages/Microsoft.Garnet). The NuGet