Skip to content

Commit fbb67ce

Browse files
committed
docs: document release process
Signed-off-by: Philippe Scorsolini <[email protected]>
1 parent 4475b07 commit fbb67ce

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

RELEASE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Release Process
2+
3+
## New Patch Release (vX.Y.Z)
4+
5+
In order to cut a new patch release from an existing release branch `release-X.Y`, follow these steps:
6+
7+
- Run the [Tag workflow][tag-workflow] on the `release-X.Y`branch with the proper release version, `vX.Y.Z`. Message suggested, but not required: `Release vX.Y.Z`.
8+
- Draft the [new release notes], and share them with the rest of the team to ensure that all the required information is included.
9+
- Publish the above release notes.
10+
11+
## New Minor Release (vX.Y.0)
12+
13+
In order to cut a new minor release, follow these steps:
14+
15+
- Create a new release branch `release-X.Y` from `master`, using the [GitHub UI][create-branch].
16+
- Run the [Tag workflow][tag-workflow] on the `release-X.Y`branch with the proper release version, `vX.Y.0`. Message suggested, but not required: `Release vX.Y.0`.
17+
- Draft the [new release notes], and share them with the rest of the team to ensure that all the required information is included.
18+
- Publish the above release notes.
19+
20+
21+
<!-- Named Links -->
22+
[create-branch]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository
23+
[new release notes]: https://github.com/crossplane/crossplane-runtime/releases/new
24+
[tag-workflow]: https://github.com/crossplane/crossplane-runtime/actions/workflows/tag.yml

0 commit comments

Comments
 (0)