From 6d66f1290a15d60002263bd0c787f278f2aca7fe Mon Sep 17 00:00:00 2001 From: Ievgenii Shepeliuk Date: Wed, 27 Oct 2021 20:45:51 +0300 Subject: [PATCH] chore: docs --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 160145e..42ee478 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,24 @@ and `${CHART_VERSION}` is a version detected by semantic-release. ### `version` and `appVersion` in Chart.yaml -qwe asd zxc +Plugin intentionally doesn't modify Chart.yaml during the release. +It's recommended to use Git tags for maintaining release versions. + +The plugin leverages `--version` and `--app-version` when calling `helm package` +to manage published chart versions and not rely on `Chart.yaml`. + +There's two usage scanarios for this plugin: + +1. The chart and the application are co-located in the same repository. + + In this case, the `version` and `appVersion` are both changed during a release. + This is a default plugin's behaviour. + +1. The chart is maintained separately from the application. + + In this case `appVersion` is modified outside of chart's release process + and must be updated manually in Chart.yaml. To prevent plugin from setting `--app-version` - + use `skipAppVersion` option. ## Configuration