Skip to content

Commit

Permalink
review fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
theboringstuff committed Nov 12, 2024
1 parent 26c7235 commit d691f75
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions documentation/internal/Release.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# Releasing KubeMarine

If you want to make a new KubeMarine release, you need to do following:
1. On the target git branch, update KubeMarine version and create tag (replace `X.X.X` with actual version):
1. On the `main` branch, update KubeMarine version and create tag (replace `X.X.X` with actual version):
```
python3 -m pip install bumpver
python3 -m bumpver update --set-version=X.X.X
```
2. Create a new pre-release for your tag on [GitHub Release page](https://github.com/Netcracker/KubeMarine/releases). Do not forget to generate release notes.
3. Wait for [GitHub Actions](https://github.com/Netcracker/KubeMarine/actions) completion and verify released artifacts. Following artifacts are essential for each release:
2. Wait for [GitHub Actions](https://github.com/Netcracker/KubeMarine/actions) completion and verify newly create pre-release on [GitHub Release page](https://github.com/Netcracker/KubeMarine/releases). Following artifacts are essential for each release:
* KubeMarine binaries for different OS. They could be found in release assets.
* KubeMarine python distribution package. It could be found in release assets.
* [KubeMarine image](https://github.com/Netcracker/KubeMarine/pkgs/container/kubemarine).
* [Kubemarine documentation](https://github.com/Netcracker/KubeMarine/tree/main/documentation).
4. Once you have verified that KubeMarine artifacts are OK, change your release from `pre-release` to `latest release` on [GitHub Release page](https://github.com/Netcracker/KubeMarine/releases). This will publish KubeMarine distribution package to PyPI.
3. Once you have verified that KubeMarine artifacts are OK, change your release from `pre-release` to `latest release` on [GitHub Release page](https://github.com/Netcracker/KubeMarine/releases). This will publish KubeMarine distribution package to PyPI.

0 comments on commit d691f75

Please sign in to comment.