Skip to content

Commit

Permalink
add release doc
Browse files Browse the repository at this point in the history
  • Loading branch information
theboringstuff committed Nov 7, 2024
1 parent 7167ff4 commit f941457
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions documentation/internal/Release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Releasing KubeMarine

If you want to make a new KubeMarine release, you need to do following:
1. 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. Wait for GitHub Actions completion and verify released artifacts. Following artifacts are essential for each tag:
* KubeMarine binaries for different OS. They could be found in release assets.
* KubeMarine python distribution package. They 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).
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 f941457

Please sign in to comment.