Skip to content

Commit

Permalink
Improve docs on releasing (#95)
Browse files Browse the repository at this point in the history
Signed-off-by: Reinhard Nägele <[email protected]>
  • Loading branch information
unguiculus authored and mattfarina committed Jan 24, 2019
1 parent 9e980f8 commit 75c69d5
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions tag.sh
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ main() {
debug=true
;;
-t|--tag)
if [ -n "${2:-}" ]; then
if [[ -n "${2:-}" ]]; then
tag="$2"
shift
else
Expand All @@ -62,7 +62,7 @@ main() {
fi
;;
-r|--remote)
if [ -n "${2:-}" ]; then
if [[ -n "${2:-}" ]]; then
remote="$2"
shift
else
Expand Down

0 comments on commit 75c69d5

Please sign in to comment.