Cadence Release Format

[longquanzheng]

Background

Typically a minor release for every month is preferred. A server release version would have gone through an internal release process which includes baking in staging clusters, stress load test in bench cluster and deployed to all production clusters in Uber before a public release. If any critical issue was discovered, the release may be delayed to fix and re-conduct the test until all metrics/logging look correct.

The process is great until publishing the release in https://github.com/uber/cadence/releases . We don't have a good format to standardize the release page. This post is to discuss some improvements on the release page so that upgrading Cadence becomes easier for users.

Proposed Release Format

Upgrading instructions from v<>

Schema upgrades if applicable

• Cassandra: upgrade schema to <>
• MySQL: upgrade schema to <>
• Postgres: upgrade schema to <>
• ElasticSearch: Add new system search attribute <> of boolean type. This is supported by Cadence to

Configuration changes

• [Optional/Required] Change <> to <> ...
  ...

Higher feature version supported

• Max supported Java SDK version bumped to ...
• Max supported Go SDK version bumped to ...
• Max supported CLI SDK version bumped to ...

Release commits

New features

• ...
• ...

Bug fixes

• Fix .....
• Fix ...
• ...

Improvements

• ...
• ...

Other proposals

• All bug fix PRs' titles should start with Fix .... so that it's easier to identify for release manager. This seems already an convention in this project, but we should document this.

• Make sure all images of server:<>-auto-setup, server:<> and cli:<> are all uploaded to docker hub. We have started doing since last release.

Note

Note 0: Usually the instruction is only for upgrading from the previous minor version

Note1: some sample commands to get the schema/config/version upgrade

 git diff v0.21.3 v0.22.0  schema/cassandra/version.go
 git diff v0.21.3 v0.22.0  schema/mysql/version.go
 git diff v0.21.3 v0.22.0  schema/postgres/version.go
 git diff v0.21.3 v0.22.0  schema/elasticsearch/v7/visibility/index_template.json
 git diff v0.21.3 v0.22.0  config/development.yaml
 git diff v0.21.3 v0.22.0  common/client/versionChecker.go

Sample command to get bug fix commits:

git log --color --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit v0.21.3..v0.22.0 | grep fix -i

Usually people like setting the alias for this:

git lg v0.21.3..v0.22.0 | grep fix -i

Sample command to get non bug fix commits:

git log --color --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit v0.21.3..v0.22.0 | grep fix -i -v

or

git lg v0.21.3..v0.22.0 | grep fix -i -v

Note2 : Idea is from other project like https://github.com/pingcap/tidb/releases/tag/v4.0.13