How to release dbt tidb

Release Rule

dbt-tidb's version following the Semantic Versioning, which looks like MAJOR.MINOR.PATCH. Here are the rules for it:

• When we change the MAJOR or MINOR: we need to create a new release branch and a corresponding tag
• When we change the PATCH: we only need to create a tag from the release branch
• Now, the version of dbt-tidb will follow the dbt-core's version

Release Step

1. Create a new release branch (ignore it when you release a patch version)
2. Update the CHANGELOG.md in the main branch
3. Replace the old CHANGELOG.md with the new CHANGELOG.md in the release branch (remember to change the version)
4. Checkout to the release branch (pull if it is outdated)
5. Release to PyPI
   • Register an account for PyPI if you don't have one
   • Delete the dist folder to avoid the file left by your last release
   • Generate the tar.gz and wheel package by the command python setup.py sdist bdist_wheel
   • Download twine by pip install twine
   • [Optional] Release to test PyPI by twine upload dist/* (need to register first)
   • Release to PyPI by python -m twine upload dist/* (you may need to enter your username and password)
6. Publish a Github release
   • Create a new tag from the release branch on the release page
   • Write release note which is the same as the changelog
   • Attach the tar.gz and wheel package that are download from the PyPI in the release page