|
| 1 | +# Dapr .NET SDK Release Process |
| 2 | + |
| 3 | +> This information is intended for SDK maintainers. SDK users can ignore this document. |
| 4 | +
|
| 5 | +## Publish a SDK Release Candidate (RC) |
| 6 | + |
| 7 | +RC release versions canonically use the form `<version>-rc<iteration>` where `<version>` represents the overall release version (e.g. `1.0`) and `<iteration>` represents a specific iteration of RC release (e.g. `01`, `02`, ..., `0n`). |
| 8 | + |
| 9 | +Assume we intend to release `<version>` (e.g. `1.0-rc01`) of the SDK. |
| 10 | + |
| 11 | +1. Create a release branch (if not already done) from `master` |
| 12 | + |
| 13 | + ```bash |
| 14 | + git checkout -b release-<version> |
| 15 | + ``` |
| 16 | + |
| 17 | +1. Push the release branch to the `dotnet-sdk` repo (i.e. typically `origin`) |
| 18 | + |
| 19 | + ```bash |
| 20 | + git push origin v<version> |
| 21 | + ``` |
| 22 | + |
| 23 | +1. Create a tag on the release branch for the RC version |
| 24 | + |
| 25 | + ```bash |
| 26 | + git tag v<version>-rc<iteration> |
| 27 | + ``` |
| 28 | + |
| 29 | +1. Push the tag to the `dotnet-sdk` repo (i.e. typically `origin`) |
| 30 | + |
| 31 | + ```bash |
| 32 | + git push origin v<version>-rc<iteration> |
| 33 | + ``` |
| 34 | + |
| 35 | + > This final step will generate a build and automatically publish the resulting packages to NuGet. |
| 36 | +
|
| 37 | +## Publish a SDK Release |
| 38 | + |
| 39 | +Official (i.e. supported) release versions canonically use the form `<version>` where `<version>` represents the overall release version (e.g. `1.0`). |
| 40 | + |
| 41 | +1. Create a release branch (if not already done) from `master` |
| 42 | + |
| 43 | + ```bash |
| 44 | + git checkout -b release-<version> |
| 45 | + ``` |
| 46 | + |
| 47 | +1. Push the release branch to the `dotnet-sdk` repo (i.e. typically `origin`) |
| 48 | + |
| 49 | + ```bash |
| 50 | + git push origin v<version> |
| 51 | + ``` |
| 52 | + |
| 53 | +1. Create a tag on the release branch for the release |
| 54 | + |
| 55 | + ```bash |
| 56 | + git tag v<version> |
| 57 | + ``` |
| 58 | + |
| 59 | +1. Push the tag to the `dotnet-sdk` repo (i.e. typically `origin`) |
| 60 | + |
| 61 | + ```bash |
| 62 | + git push origin v<version> |
| 63 | + ``` |
| 64 | + |
| 65 | + > This final step will generate a build and automatically publish the resulting packages to NuGet. |
| 66 | +
|
| 67 | +## NuGet Package Publishing |
| 68 | + |
| 69 | +Publishing to NuGet requires keys generated by a member of the Dapr organization. Such keys are added as a [GitHub Action secret](https://github.com/dapr/dotnet-sdk/settings/secrets/actions) with the name `NUGETORG_DAPR_API_KEY` These keys expire and therefore must be maintained and the GitHub Actions secret updated periodically. |
0 commit comments