Skip to content

Commit ba018fb

Browse files
scottrigbyunguiculus
authored andcommitted
Document supported versions, upgrading, and version-specific PRs (#47)
Signed-off-by: Scott Rigby <[email protected]>
1 parent 09a6f11 commit ba018fb

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -146,3 +146,13 @@ Create and push a tag.
146146
-t, --tag The name of the tag to create
147147
-s, --skip-push Skip pushing the tag
148148
```
149+
150+
## Supported versions
151+
152+
The previous MAJOR version will be supported for three months after each new MAJOR release.
153+
154+
Within this support window, pull requests for the previous MAJOR version should be made against the previous release branch. For example, if the current MAJOR version is `v2`, the pull request base branch should be `release-v1`.
155+
156+
## Upgrading
157+
158+
When upgrading from `< v2.0.0` you will also need to change the usage in your scripts. This is because, while the [v2.0.0](https://github.com/helm/chart-testing/releases/tag/v2.0.0) release has parity with `v1`, it was refactored from a bash library to Go so there are minor syntax differences. Compare [v1 usage](https://github.com/helm/chart-testing/tree/release-v1#usage) with this (`v2`) version's README [usage](#usage) section above.

0 commit comments

Comments
 (0)