Add dotnet tool support (#212)

Author: pm7y

.github/workflows/nuget-release.yml

@@ -0,0 +1,66 @@
+name: NuGet Release
+
+on:
+  release:
+    types: [published]
+
+  workflow_dispatch:
+    inputs:
+      tag_name:
+        description: "Release tag name (e.g., '1.0.1')"
+        required: true
+        type: string
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
+
+permissions:
+  contents: read
+
+env:
+  VERSION_NUMBER: ${{ github.event.inputs.tag_name || github.event.release.tag_name }}
+  DOTNET_VERSION: "10.0.x"
+  DOTNET_CLI_TELEMETRY_OPTOUT: "1"
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: "1"
+  DOTNET_NOLOGO: "true"
+  PROJECT_PATH: ./src/AzureEventGridSimulator/AzureEventGridSimulator.csproj
+  CONFIGURATION: Release
+
+jobs:
+  publish-nuget:
+    name: Publish to NuGet
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: ${{ env.DOTNET_VERSION }}
+
+      - name: Restore dependencies
+        run: dotnet restore ${{ env.PROJECT_PATH }}
+
+      - name: Build
+        run: >-
+          dotnet build ${{ env.PROJECT_PATH }}
+          --configuration ${{ env.CONFIGURATION }}
+          --no-restore
+
+      - name: Pack
+        run: >-
+          dotnet pack ${{ env.PROJECT_PATH }}
+          --configuration ${{ env.CONFIGURATION }}
+          --no-build
+          /p:Version=${{ env.VERSION_NUMBER }}
+          --output ./nupkg
+
+      - name: Push to NuGet
+        run: >-
+          dotnet nuget push ./nupkg/*.nupkg
+          --api-key ${{ secrets.NUGET_API_KEY }}
+          --source https://api.nuget.org/v3/index.json
+          --skip-duplicate

README.md

@@ -5,9 +5,40 @@
 ![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/pmcilreavy/AzureEventGridSimulator?label=latest)
 ![GitHub all releases](https://img.shields.io/github/downloads/pmcilreavy/AzureEventGridSimulator/total)
 ![Docker Pulls](https://img.shields.io/docker/pulls/pmcilreavy/azureeventgridsimulator)
+![NuGet Version](https://img.shields.io/nuget/v/AzureEventGridSimulator)
 
 A simulator that provides endpoints to mimic the functionality of [Azure Event Grid](https://azure.microsoft.com/en-au/services/event-grid/) topics and subscribers and is compatible with the `Microsoft.Azure.EventGrid` client library. Both the `EventGrid` schema and the `CloudEvents v1.0` schema are supported.
 
+## Installation
+
+### .NET Tool (Recommended)
+
+Install as a global .NET tool:
+
+```bash
+dotnet tool install -g AzureEventGridSimulator
+```
+
+Then run with:
+
+```bash
+azure-eventgrid-simulator
+```
+
+To update to the latest version:
+
+```bash
+dotnet tool update -g AzureEventGridSimulator
+```
+
+### Docker
+
+See the [Docker](#docker) section below for running via Docker.
+
+### Binary Release
+
+Download standalone executables from [GitHub Releases](https://github.com/pmcilreavy/AzureEventGridSimulator/releases).
+
 ## Configuration
 
 Topics and their subscribers are configured in the `appsettings.json` file.

src/AzureEventGridSimulator/AzureEventGridSimulator.csproj

@@ -1,8 +1,29 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
   <PropertyGroup>
     <IsWebConfigTransformDisabled>true</IsWebConfigTransformDisabled>
+
+    <!-- .NET Tool packaging -->
+    <IsPackable>true</IsPackable>
+    <PackAsTool>true</PackAsTool>
+    <ToolCommandName>azure-eventgrid-simulator</ToolCommandName>
+    <PackageId>AzureEventGridSimulator</PackageId>
+    <PackageOutputPath>./nupkg</PackageOutputPath>
+
+    <!-- NuGet metadata -->
+    <Authors>Paul McIlreavy</Authors>
+    <Description>A simulator that provides endpoints to mimic the functionality of Azure Event Grid topics and subscribers. Compatible with the Microsoft.Azure.EventGrid client library. Supports both EventGrid and CloudEvents v1.0 schemas.</Description>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageProjectUrl>https://github.com/pmcilreavy/AzureEventGridSimulator</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/pmcilreavy/AzureEventGridSimulator</RepositoryUrl>
+    <RepositoryType>git</RepositoryType>
+    <PackageTags>azure;eventgrid;event-grid;simulator;emulator;development;testing</PackageTags>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="../../README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Asp.Versioning.Mvc" />
     <PackageReference Include="Serilog.AspNetCore" />