1
0
mirror of https://github.com/helm/chart-testing.git synced 2026-02-05 18:45:18 +01:00

Improve docs on releasing (#95)

Signed-off-by: Reinhard Nägele <unguiculus@gmail.com>
This commit is contained in:
Reinhard Nägele
2019-01-24 15:46:07 +01:00
committed by Matt Farina
parent 9e980f87cc
commit 75c69d57de
2 changed files with 20 additions and 2 deletions

View File

@@ -148,6 +148,14 @@ Build ct using Goreleaser.
## Releasing
### Prepare Release
Before a release is created, versions have to be updated in the examples.
A pull request needs to be created for this, which should be merged right before the release is cut.
Here's a previous one for reference: https://github.com/helm/chart-testing/pull/89
### Create Release
CircleCI creates releases automatically when a new tag is pushed. Tags are created using `tag.sh`.
```console
@@ -164,6 +172,16 @@ Create and push a tag.
-s, --skip-push Skip pushing the tag
```
By default, the script assumes that `origin` points to your own fork and that you have a remote `upstream` that points to the upstream `chart-testing` repo.
Run the script specifying the version for the new release.
```console
./tag.sh --tag <release_version>
```
Versions must start with a lower-case `v`, e. g. `v2.2.0`.
## Supported versions
The previous MAJOR version will be supported for three months after each new MAJOR release.

4
tag.sh
View File

@@ -52,7 +52,7 @@ main() {
debug=true
;;
-t|--tag)
if [ -n "${2:-}" ]; then
if [[ -n "${2:-}" ]]; then
tag="$2"
shift
else
@@ -62,7 +62,7 @@ main() {
fi
;;
-r|--remote)
if [ -n "${2:-}" ]; then
if [[ -n "${2:-}" ]]; then
remote="$2"
shift
else