From 9b711d88b7f598de48b90918ea8dec893c555f30 Mon Sep 17 00:00:00 2001 From: Julian Gieseke Date: Fri, 14 Feb 2020 23:17:01 +0100 Subject: [PATCH] docs: add short term guideance to readme (#5) * docs: add short term guideance to readme * add release notes --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 0760cfb8..5bf9426b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # Kommander Addon Repository This is a [kubernetes addon](https://github.com/mesosphere/kubeaddons) repository which contains [Kommander](https://github.com/mesosphere/kommander) related addon applications. + +# Updating Kommander Addon + +**This section is only intended for short term guideance and might not be/stay 100% accurate, please get rid of whatever you see that seems wrong.** +**this repo follows (mostly?) the same rules as https://github.com/mesosphere/kubernetes-base-addons - so please check readme files over there** + +to update kommander chart, _rename_ current revision and update the file as needed (usualy just chart version). +in case we need to support multiple versions at the same time, its a good idea to use directories for it (1.x, 2.x, maybe even 1.1.x and 1.2.x if necessary, we can rename directories as needed). supporting multiple revisions at the same time shouldnt be necessary for kommander at this point. + +# Releasing Kommander Addon + +**same caveat as above, releas eprocess is being defined in https://github.com/mesosphere/kubernetes-base-addons currently.** + +current thinking is to have branches per supported kommander version (1.x, 2.x,…) and release tags that follow a k8s based scheme `--` (e.g. `stable-1.16-1.0.0`). this means for every release of kommander, there are (usually) three release tags (we support k8s n-2 versions).