This document describes the steps to create a new release of grpc-dotnet. The release process is based on the release process used by the grpc/grpc repository.
Releases follow the gRPC-wide release schedule. There might be a slight delay if there are release blockers to resolve and/or we need to wait for the Grpc.Core.Api release that the new release depends on.
-
Before cutting the release branch:
- If needed, on the master branch update the
Grpc.ToolsandGrpc.Coredependency versions in Directory.Packages.props to the latest applicable pre-release or stable version produced by the grpc/grpc release process. - Make sure that any patches or bug fixes from the last released branch have been applied to the master branch as well.
- Confirm that all four version values listed below are set to the current development version on master. Do not assume that cutting a branch updates them.
- If needed, on the master branch update the
-
Cut the release branch from the master branch (the branch format is
v2.25.x,v2.26.x, ...). This release branch will be used for all subsequent pre-releases and patch releases within the same release cycle. -
On the release branch, set all four version values for the pre-release. For example, when preparing
2.80.0-pre1:File Value Pre-release example build/version.props GrpcDotnetVersion2.80.0-pre1build/version.props GrpcDotnetAssemblyFileVersion2.80.0.0src/Grpc.Core.Api/VersionInfo.cs CurrentVersion2.80.0-pre1src/Grpc.Core.Api/VersionInfo.cs CurrentAssemblyFileVersion2.80.0.0- The package and current versions include the pre-release suffix. The file versions are numeric and do not include it.
GrpcDotnetAssemblyFileVersionandCurrentAssemblyFileVersionmust match and must not be lower than the file version of the previous stable release.GrpcDotnetAssemblyVersionandCurrentAssemblyVersionremain2.0.0.0; verify that they still match.- Check that the release version matches the release branch name.
-
Build the signed NuGet packages (internal process). These are the pre-release packages. Before pushing them, inspect the package metadata and a DLL from each produced package that contains assemblies, and confirm that:
- The NuGet package version and DLL
ProductVersionmatchGrpcDotnetVersion. - The DLL
FileVersionmatchesGrpcDotnetAssemblyFileVersion. Grpc.Core.Api.VersionInforeports the values set above. Push the packages to nuget.org only after these checks pass.
- The NuGet package version and DLL
-
Create a new release and tag in https://github.com/grpc/grpc-dotnet/releases (by creating the tag from the current release branch). Mark the release as "pre-release" in the GitHub UI. Fill in the release notes.
-
Wait for the stable release of
Grpc.Toolsfrom thegrpc/grpcrepository (as scheduled by the release schedule), and keep checking the issue tracker for problems with the new grpc-dotnet pre-release packages. If problems are discovered and they need to be fixed, the release manager might choose to release more pre-releases (-pre2,-pre3, ...) before deciding to release as stable. For each additional pre-release, update bothGrpcDotnetVersionandCurrentVersionto the new suffix and repeat the package checks in step 4. -
Make sure at least 7 days have elapsed since the last pre-release before proceeding with the stable release, to give users enough time to test the pre-release NuGet packages and discover potential issues. This decreases the likelihood of pushing a bad stable release.
-
Once the stable version of
Grpc.Toolsis pushed, prepare the stable release:- Update the
Grpc.Toolsdependency inDirectory.Packages.propsif it does not already reference the stable version. - Remove the pre-release suffix from both
GrpcDotnetVersionandCurrentVersion. - Verify again that
GrpcDotnetAssemblyFileVersionandCurrentAssemblyFileVersioncontain the numeric stable version and match each other. Do not leave either value at an older release. - Verify that
GrpcDotnetAssemblyVersionandCurrentAssemblyVersionremain2.0.0.0and match each other.
- Update the
-
Build the signed NuGet packages (internal process). These are the stable grpc-dotnet packages. Repeat all artifact checks in step 4 against the stable version, then push the packages to nuget.org.
-
Create a new release and tag in https://github.com/grpc/grpc-dotnet/releases (by creating the tag from the current release branch). This is the stable release. Fill in the release notes and list changes since the previous stable version.
On the master branch, increase the version number to indicate the start of a new release cycle (2.25.0-dev becomes 2.26.0-dev). Update all four values from step 3: use the new -dev version for GrpcDotnetVersion and CurrentVersion, and the corresponding numeric version for GrpcDotnetAssemblyFileVersion and CurrentAssemblyFileVersion.
- Create patch releases from an existing release branch by bumping the patch component in all four values from step 3. Use the patch's pre-release or stable version for
GrpcDotnetVersionandCurrentVersion, and its numeric version forGrpcDotnetAssemblyFileVersionandCurrentAssemblyFileVersion. Repeat the artifact checks in step 4. - When bug fixes are merged to a release branch, make sure they are synced into the master branch as well; otherwise, the fixes might be missing from the next release cycle.