Skip to content

How to Release

Sparkle edited this page Nov 2, 2023 · 12 revisions
  1. From the latest release branch, create a new branch in your repository, using whatever name you like. Example:

    git fetch origin
    git checkout -b release-20210330 origin/release
  2. Cherry pick commits you want to carry from the master branch in this release.

  3. Update the release-version file using the current calendar date and commit, for example, 2021.03.30.1

  4. Push your branch.

  5. Open a pull request that merges to release branch, use title likes "Release v2021.03.30.1". Add [skip pd_pr] in the end to skip auto-submit PR to PD.

  6. Ask @breeswish to review and merge.

  7. The release tag and release artifacts will be created automatically.

  8. Normally, as a follow-up, you will need to update PD to use this new TiDB Dashboard release. You can update the TiDB Dashboard in PD by using:

    # in PD repo:
    go get -d github.com/pingcap/tidb-dashboard@<RELEASE_VERSION>
    go mod tidy
    make pd-server
    go mod tidy
    
    cd tests/integrations/client
    go mod tidy
    cd ../mcs
    go mod tidy
    cd ../tso
    go mod tidy

    Example:

    go get -d github.com/pingcap/[email protected]
    go mod tidy
    make pd-server
    go mod tidy
    
    cd tests/integrations/client
    go mod tidy
    cd ../mcs
    go mod tidy
    cd ../tso
    go mod tidy

    Then, commit the changes with --signoff option and with the message likes "Update dashboard to v2021.03.30.1", propose to Pull Requests in PD.