Skip to content

Commit 5131eab

Browse files
Add release notes
1 parent 6f61067 commit 5131eab

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+
This document walks through the release process for helm-operator-plugins.
2+
3+
1. Creation of pre-release PR:
4+
5+
Update the release version of the plugin at the following locations in the file - `pkg/plugins/hybrid/v1alpha/scaffolds/init.go`. As an example, let us assume that we are about to update the release version from `v0.0.9` to `v0.0.10`. To do so, modify the `hybridOperatorVersion` and `helmPluginVersion` variables to `v0.0.10`.
6+
7+
```diff
8+
- hybridOperatorVersion = "0.0.9"
9+
+ hybridOperatorVersion = "0.0.10"
10+
11+
// helmPluginVersion is the operator-framework/helm-operator-plugin version to be used in the project
12+
- helmPluginVersion = "v0.0.9"
13+
+ helmPluginVersion = "v0.0.10"
14+
```
15+
16+
Run `make generate` to re-generate the `testdata/` with above modifications.
17+
18+
**Note**
19+
The release PR with the above mentioned change will **fail** the `sanity` test and needs to be merged forcefully. This step is done because the packages which are to be imported in the scaffolded project and the plugin code reside in the same repository. This will ensure that after the release, the plugin will also import the updated version of library helpers.
20+
21+
2. Create a release branch with the name vX.Y.x. Example: `git checkout -b v0.0.10`.
22+
23+
3. Tag the release commit and verify the generated tag.
24+
25+
```
26+
export VER=v0.0.10
27+
git tag --sign --message "helm-operator-plugin $VER" "$VER"
28+
git verify-tag --verbose $VER
29+
```
30+
31+
4. Push the release branch and tag:
32+
33+
```
34+
git push upstream <release-branch>
35+
git push upstream $VER
36+
```
37+
38+
5. Make sure that the release notes are updated in the github release page (Github provides an option to auto-generate the notes).
39+
40+
6. After the release, make sure to run `make test-sanity` from the main branch to ensure that `testdata` is up-to date. If not, create a PR to update the changes.
41+
42+
43+
44+
45+

0 commit comments

Comments
 (0)