From 7ea215868efb4d7bccc4396d4435d6897d90fde1 Mon Sep 17 00:00:00 2001 From: Luke Date: Tue, 7 Feb 2023 08:40:00 -0500 Subject: [PATCH] updated release instructions package tags for satori (#137) --- RELEASEINST.md | 28 ++++++++++++++++++++-------- Satori/Satori.csproj | 2 +- 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/RELEASEINST.md b/RELEASEINST.md index 8ff709c3..6b9329be 100644 --- a/RELEASEINST.md +++ b/RELEASEINST.md @@ -1,15 +1,15 @@ Release Instructions === -These instructions guide the release process for new official Nakama client SDK build and releases to [Nuget](https://www.nuget.org/packages/NakamaClient/). +This document outlines the release of the Nakama and Satori .NET clients to Github and [Nuget](https://www.nuget.org/packages/NakamaClient/). -## Steps +Our current monorepo strategy is to maintain the Nakama and Satori clients in the same repo per language. Clients are published together under Github under the same tag and version, even if only one has changed. Clients are released independently to Nuget. 1. Update and tidy up the CHANGELOG. -2. Run the test suite for the codebase. See the README for steps. +2. Run the test suite for the codebase. See the README for instructions. -3. Create the release commit and tag it. +3. Create a tag for the new release. This tag applies to both Nakama and Satori .NET: ```shell git add CHANGELOG @@ -18,17 +18,21 @@ These instructions guide the release process for new official Nakama client SDK git push origin master ``` -4. Create a release build of the code. - +4. Build Nakama ```shell dotnet build -c Release ./Nakama/Nakama.csproj ``` +5. Build Satori + + ```shell + dotnet build -c Release ./Satori/Satori.csproj + ``` 5. Create a release on GitHub: https://github.com/heroiclabs/nakama-dotnet/releases/new -6. Copy the CHANGELOG section to the release notes. Upload the release DLL to be part of the GitHub release. Publish it. +6. Copy the CHANGELOG section to the release notes. Upload the release DLLs to be part of the GitHub release. Publish it. -7. Package and push the release to Nuget. Don't put a `v` prefix before the version number. +7. Package and push the releases to Nuget. Don't put a `v` prefix before the version number. ```shell dotnet pack -p:AssemblyVersion= -p:PackageVersion= -c Release ./Nakama/Nakama.csproj @@ -38,6 +42,14 @@ These instructions guide the release process for new official Nakama client SDK dotnet nuget push ./Nakama/bin/Release/NakamaClient..nupkg -k "somekey" -s https://api.nuget.org/v3/index.json ``` + ```shell + dotnet pack -p:AssemblyVersion= -p:PackageVersion= -c Release ./Satori/Satori.csproj + ``` + + ```shell + dotnet nuget push ./Satori/bin/Release/SatoriClient..nupkg -k "somekey" -s https://api.nuget.org/v3/index.json + ``` + 8. Update CHANGELOG with section for new unreleased changes. ```shell diff --git a/Satori/Satori.csproj b/Satori/Satori.csproj index 32fb220c..0a4caeb4 100644 --- a/Satori/Satori.csproj +++ b/Satori/Satori.csproj @@ -16,7 +16,7 @@ SatoriClient Apache-2.0 - + gameserver;client-library;satori;liveops https://github.com/heroiclabs/nakama-dotnet