Skip to content

Commit

Permalink
Merge pull request #501 from phisco/release-md
Browse files Browse the repository at this point in the history
  • Loading branch information
phisco authored Aug 7, 2023
2 parents 794f645 + fbb67ce commit 30a1489
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Release Process

## New Patch Release (vX.Y.Z)

In order to cut a new patch release from an existing release branch `release-X.Y`, follow these steps:

- 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`.
- Draft the [new release notes], and share them with the rest of the team to ensure that all the required information is included.
- Publish the above release notes.

## New Minor Release (vX.Y.0)

In order to cut a new minor release, follow these steps:

- Create a new release branch `release-X.Y` from `master`, using the [GitHub UI][create-branch].
- 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`.
- Draft the [new release notes], and share them with the rest of the team to ensure that all the required information is included.
- Publish the above release notes.


<!-- Named Links -->
[create-branch]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository
[new release notes]: https://github.com/crossplane/crossplane-runtime/releases/new
[tag-workflow]: https://github.com/crossplane/crossplane-runtime/actions/workflows/tag.yml

0 comments on commit 30a1489

Please sign in to comment.