Skip to content

Commit 5c8a13b

Browse files
author
John Luo
authored
Add documentation for versioning policy going forward (#542)
1 parent 068b94d commit 5c8a13b

File tree

3 files changed

+34
-2
lines changed

3 files changed

+34
-2
lines changed

doc/images/packages.png

4.93 KB
Loading

doc/versioning.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# gRPC-dotnet package versioning policies
2+
3+
## Overview
4+
5+
This document covers versioning policies of the packages produced in this repo:
6+
7+
- Grpc.AspNetCore
8+
- Grpc.AspNetCore.Server
9+
- Grpc.AspNetCore.Server.ClientFactory
10+
- Grpc.Net.Client
11+
- Grpc.Net.ClientFactory
12+
- Grpc.Net.Common
13+
- dotnet-grpc
14+
15+
## Design considerations
16+
17+
### Major version number
18+
19+
The initial major version number was set to 2 to match the release of corresponding Grpc.Core packages. Going forward, the major version will be incremented when there's a need to ingest a major Grpc.Core or ASP.NET Core dependency for breaking changes. grpc-dotnet complies with the gRPC-wide [versioning policy](https://github.com/grpc/grpc/blob/master/doc/versioning.md) and the major version will only be incremented on rare occasions.
20+
21+
### Minor version number
22+
23+
The initial minor version number was set to 23 to match the release of corresponding Grpc.Core packages. Going forward, we will be releasing on the Grpc.Core [schedule](https://github.com/grpc/grpc/blob/master/doc/grpc_release_schedule.md) and will match the minor version number of the corresponding release.
24+
25+
### Patch version number
26+
27+
The patch number will increment for patches of existing major.minor release. These patches are built out of the v{major}.{minor}.x branches on GitHub, e.g. https://github.com/grpc/grpc-dotnet/tree/v2.23.x.
28+
29+
## Pre-release and nightly suffixes
30+
31+
The suffix -pre{x} will be added to pre-release packages released to nuget.org. These are non-stable packages intended for early ingestion of upcoming releases.
32+
The suffix -dev is added to packages produced by nightly builds available from the NuGet feed https://grpc.jfrog.io/grpc/api/nuget/v3/grpc-nuget-dev.

src/Grpc.AspNetCore.Server/Grpc.AspNetCore.Server.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<IsGrpcPublishedPackage>true</IsGrpcPublishedPackage>
88
<GenerateDocumentationFile>true</GenerateDocumentationFile>
99
<TargetFramework>netcoreapp3.0</TargetFramework>
10-
10+
1111
<!-- Disable analysis for ConfigureAwait(false) -->
1212
<WarningsNotAsErrors>$(WarningsNotAsErrors);CA2007</WarningsNotAsErrors>
1313
<NoWarn>$(NoWarn);CA2007</NoWarn>
@@ -22,7 +22,7 @@
2222
<FrameworkReference Include="Microsoft.AspNetCore.App" />
2323

2424
<ProjectReference Include="..\Grpc.Net.Common\Grpc.Net.Common.csproj" />
25-
25+
2626
<PackageReference Include="Grpc.Core.Api" Version="$(GrpcPackageVersion)" />
2727
</ItemGroup>
2828

0 commit comments

Comments
 (0)