Merge pull request #305 from MikeSpreitzer/updoc-wrt-release-241105

📖  Update documentation of release process

docs/contributors.md

@@ -49,39 +49,32 @@ LATEST_TAG=<tag used for image> make ko-build-push-cmupdate
 
 ## Steps to make release
 
-1. delete branch "brew" from https://github.com/kubestellar/kubeflex 
-2. git checkout <release branch> # e.g. release-0.3
-3. Run the rebase from main
-```
-gitr(){
-  CURRENT=$(git rev-parse --abbrev-ref HEAD)
-  echo "rebasing $CURRENT"
-  git checkout main && git fetch upstream && git merge upstream/main && git checkout $CURRENT && git rebase main
-}
-gitr
-```
-4. Push the release branch with "git push" - open PR and review/merge to update release branch upstream.
-
-5. check existing tags e.g.,
-```
-git tag 
-v0.1.0
-v0.1.1
-v0.2.0
-...
-v0.3.1
-```
-6. create a new tag e.g.
-```
-git tag v0.3.2
-```
-7. Push the tag upstream
-```
-git push upstream --tag v0.3.2
-```
-Wait until goreleaser completes the release process.
-
-8. Make a PR from the brew branch for the brew install script.
+1. Delete branch "brew" from https://github.com/kubestellar/kubeflex, if there is such a branch.
+
+1. `git checkout main` and make sure it (a) equals `main` in https://github.com/kubestellar/kubeflex and (b) is what you want to release.
+
+1. check existing tags e.g.,
+   ```
+   git tag 
+   v0.1.0
+   v0.1.1
+   v0.2.0
+   ...
+   v0.3.1
+   ```
+1. create a new tag e.g.
+   ```
+   git tag v0.3.2
+   ```
+1. Push the tag upstream
+   ```
+   git push upstream --tag v0.3.2
+   ```
+   Wait until goreleaser completes the release process.
+
+1. The goreleaser workflow will also create a branch named `brew` with some changes (to the homebrew instsall script) that need to get merged into `main`. Make a PR to merge `brew` into `main`, and get it approved and merged.
+
+1. To avoid leaving a time bomb, delete that `brew` branch after it was merged into `main` (the goreleaser will fail to create the new `brew` branch if one already exists).
 
 
 ## OCM Images