diff --git a/RELEASE.md b/RELEASE.md index 9c1c00daa..d64424531 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -38,6 +38,8 @@ The official binaries for KUDO are created using [goreleaser](https://goreleaser It is possible outside of the standard release process to build a "snapshot" release using the following command: `goreleaser release --skip-publish --snapshot --rm-dist` This process will create a "dist" folder with all the build artifacts. The changelog is not created unless a full release is executed. If you are looking to get a "similar" changelog, install [github-release-notes](https://github.com/buchanae/github-release-notes) and execute `github-release-notes -org kudobuilder -repo kudo -since-latest-release`. +**Note:** The release note for a full release should contain all changes since the last non-pre-release. For example a `0.16.0` changelog should contain all changes since `0.15.3`, *not* only the changes since `0.16.0-rc2`. + ### Cutting a Release Branch As outlined above, when it is necessary to create a new release branch, it is necessary to update the [circle-ci config](https://github.com/kudobuilder/kudo/blob/master/.circle-ci/config.yml#L13) to test merges against the correct branch. It is necessary replace all references to `master` with the appropriate release branch. @@ -58,3 +60,5 @@ This is the full pre-release step by step: 1. Tag repo with expected pre-release (the name of the tag has to contain e.g. rc1 or similar) `git tag -a v0.2.0-rc1 -m "v0.2.0-rc1"` && push tag `git push --tags`. 1. Invoke goreleaser `goreleaser --rm-dist`. 1. Push only versioned docker image via `docker push kudobuilder/controller:v0.2.0-rc1` + +**Note:** The release notes for a pre-release should contain all changes since any previously released version. For example `0.16.0-rc1` should list all changes since `0.15.3` if that was the latest `0.15` release. `0.16.0-rc2` would contain all changes since `0.16.0-rc1`. \ No newline at end of file