Skip to content
This repository has been archived by the owner on Jul 19, 2024. It is now read-only.

Commit

Permalink
chore: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eshepelyuk committed Oct 27, 2021
1 parent 61f6651 commit 6d66f12
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 6d66f12

Please sign in to comment.