Skip to content

Commit b8d5a1d

Browse files
authored
Start to document the release process (#234)
1 parent e0a12c4 commit b8d5a1d

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/release.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Release Process
2+
3+
Github Actions is the primary release tool, most of the heavy lifting is done in the following workflow: `.github/workflows/release.yaml`
4+
5+
## Starting the process
6+
7+
To start a new release, we first need to create a branch using the following convention: `release-vX.Y.Z`
8+
9+
Once this branch has been created, GitHub actions will update all relevant version numbers to the appropriate branch version.
10+
11+
This will then raise a PR for review.
12+
13+
Once reviewed and approved, a contributor must checkout `main` and tag the `main` branch with the relevant tag from the branch/PR.
14+
15+
This will trigger the full release workflow and push container images and create the GitHub release too.

0 commit comments

Comments
 (0)