Skip to content

RELEASING.md

Latest commit

 

History

History
74 lines (53 loc) · 2.24 KB

RELEASING.md

File metadata and controls

74 lines (53 loc) · 2.24 KB
Raw

Releasing

SeedLang for C# and Unity

The NuGet package of SeedLang

https://www.nuget.org/packages/SeedLang/

Publishing a pre-release build

To publish a pre-release build of the NuGet package:

cd csharp
dotnet clean
rm src/SeedLang/bin/Release/SeedLang.*.nupkg
dotnet pack src/SeedLang -c Release -p:ReleaseTag=preview
dotnet nuget push src/SeedLang/bin/Release/SeedLang.*.nupkg --api-key <apikey> \
  --source https://api.nuget.org/v3/index.json

ReleaseTag can be an arbitrary string tag to indicate the build type. Recommended tags include alpha, beta and preview.

The <apikey> to access NuGet.org is maintained by the administrator of the dev team.

The semantic version number <major>.<minor>.<patch> will not change when publishing pre-release builds, while the pre-release tag will be updated, composed of the release tag and an auto-generated timestamp. For example:

0.1.2-preview20211013074315

Publishing a formal release build

To publish a formal release build of the NuGet package:

Manually assign a new version number <major>.<minor>.<patch> to the release build.

Prepare a versioning PR to update the VersionPrefix property in the following two project files:

Get the versioning PR approved by the dev team and merged into the main branch.

In GitHub, create a new release for SeedLang and assign a release tag to the main branch. The release tag is typically formatted as v<major>.<minor>.<patch>.

Build the SeedLang package and publish it to NuGet:

cd csharp
dotnet clean
rm src/SeedLang/bin/Release/SeedLang.*.nupkg
dotnet pack src/SeedLang -c Release -p:ReleaseTag=release
dotnet nuget push src/SeedLang/bin/Release/SeedLang.*.nupkg --api-key <apikey> \
 --source https://api.nuget.org/v3/index.json

Once ReleaseTag is set to release as in the above command line, an auto-generated timestamp will be attached to the semantic version number as its build metadata. For example:

0.1.2+20211013074315