Skip to content

Commit

Permalink
updated release instructions package tags for satori (#137)
Browse files Browse the repository at this point in the history
  • Loading branch information
Luke authored Feb 7, 2023
1 parent 7f1da59 commit 7ea2158
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 9 deletions.
28 changes: 20 additions & 8 deletions RELEASEINST.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -18,17 +18,21 @@ These instructions guide the release process for new official Nakama client SDK
git push origin <version> 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=<package-version> -p:PackageVersion=<package-version> -c Release ./Nakama/Nakama.csproj
Expand All @@ -38,6 +42,14 @@ These instructions guide the release process for new official Nakama client SDK
dotnet nuget push ./Nakama/bin/Release/NakamaClient.<package-version>.nupkg -k "somekey" -s https://api.nuget.org/v3/index.json
```

```shell
dotnet pack -p:AssemblyVersion=<package-version> -p:PackageVersion=<package-version> -c Release ./Satori/Satori.csproj
```

```shell
dotnet nuget push ./Satori/bin/Release/SatoriClient.<package-version>.nupkg -k "somekey" -s https://api.nuget.org/v3/index.json
```

8. Update CHANGELOG with section for new unreleased changes.

```shell
Expand Down
2 changes: 1 addition & 1 deletion Satori/Satori.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
</Description>
<PackageId>SatoriClient</PackageId>
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
<PackageTags></PackageTags>
<PackageTags>gameserver;client-library;satori;liveops</PackageTags>
<RepositoryUrl>https://github.com/heroiclabs/nakama-dotnet</RepositoryUrl>
</PropertyGroup>
</Project>

0 comments on commit 7ea2158

Please sign in to comment.