Skip to content

Commit 8ab56c9

Browse files
ci: add release.md
Signed-off-by: nelson.parente <[email protected]>
1 parent 61ea4b0 commit 8ab56c9

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

RELEASE.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Release Guide
2+
3+
This document describes how to release Dapr Components Contrib along with associated artifacts.
4+
5+
## Prerequisites
6+
7+
Only maintainers and the release team should run releases.
8+
9+
## Pre-release
10+
11+
Pre-releases use tags like `v1.11.0-rc.0`, `-rc.1`, and so on. They are created through the GitHub Actions workflow.
12+
13+
### Steps
14+
15+
1. Update the Dapr runtime and dashboard versions in workflows or tests if needed. Merge that change to master.
16+
17+
2. Open GitHub Actions and click the **create-release** workflow.
18+
19+
3. Press the **Run workflow** button.
20+
The workflow will:
21+
22+
* create the `release-<major>.<minor>` branch
23+
* create the pre-release tag
24+
* build the artifacts
25+
26+
4. Test the produced build.
27+
28+
5. If there are issues, fix them in the release branch and trigger the workflow again by creating a new pre-release tag (for example `-rc.1`).
29+
30+
6. Repeat until the build is good.
31+
32+
## Stable Release
33+
34+
Create a stable tag without the rc suffix (for example `v1.11.0`).
35+
CI will build and publish the release.
36+
37+
## Patch Releases
38+
39+
Use the existing release branch.
40+
Create a new pre-release tag like `v1.11.1-rc.0`, test it, and when ready tag the stable version `v1.11.1`.
41+
CI will build and publish it.
42+
43+
## Project Release Guidelines
44+
45+
See [this document](https://github.com/dapr/community/blob/master/release-process.md) for the project's release process and guidelines.

0 commit comments

Comments
 (0)