Adding some missing steps to release guide

This commit is contained in:
Gunnar Morling 2017-06-12 15:13:45 +02:00
parent cac6044cd5
commit 2292d457a7

View File

@ -2,6 +2,14 @@
The Debezium project uses Maven for its build system, relying up on the _release_ plugin to most of the work. This document describes the steps required to perform a release.
# Update the changelog
The change log should be updated with all relevant info on new features, bug fixes and breaking changes.
It currently exists in two versions, one in the main code repo and one on the website:
* https://github.com/debezium/debezium/blob/master/CHANGELOG.md
* https://github.com/debezium/debezium.github.io/blob/develop/docs/releases.asciidoc
## Start with the correct branch
Make sure that you are on the correct branch that is to be released, and that your local Git repository has all of the most recent commits. For example, to release from the `master` branch on the remote repository named `upstream`:
@ -154,6 +162,14 @@ Only after the artifacts are available on Maven Central can you merge the pull r
Otherwise, for major and minor releases your pull request should have added new Docker images, and you need to log into [Debezium's Docker Hub organization](https://hub.docker.com/r/debezium/) and add/update the build settings for each of the affected images.
If the logical decoding plug-in has undergone any changes as part of the release, the Docker image for PostgreSQL needs to be updated as well.
First create a tag in the https://github.com/debezium/postgres-decoderbufs[postgres-decoderbufs] repository:
$ git tag v<%version%> && git push upstream v<%version%>
Then update the Debezium version referenced in the https://github.com/debezium/docker-images/blob/master/postgres/9.6/Dockerfile#L22[postgres Docker file]
and push that commit which will cause the image to be re-published on Docker Hub automatically.
## Update the documentation and blog
Update the documentation on the [Debezium website](http://debezium.io) by following the [instructions for changing the website](http://debezium.io/docs/contribute/#website). This typically involes updating the documentation and writing a blog post to announce the release. Then, create a pull request with your changes and wait for a committer to approve and merge your changes.