RELEASE.md

Release Procedure

Bump version

1. Open a branch for the release
   • git checkout -b releases/1.0.0rc1
2. Update CHANGELOG.md with the most recent changes
3. Bump the version using bump2version:

   1. Dry run first by running:

      bumpversion --dry-run --verbose --new-version <desired-version> <part>
      

      Some examples:

      • Release candidates: --new-version 0.10.2rc1 num
      • Alpha releases: --new-version 0.10.2a1 num
      • Patch releases: --new-version 0.10.2.1 patch
      • Minor releases: --new-version 0.11.0.1 minor
      • Major releases: --new-version 1.0.0.1 major

   2. Actually modify the files, tag and commit to git:

      bumpversion --tag --commit --new-version <desired-version> <part>
      

   3. Push change to the origin:

      git push origin
      git push origin --tags
      

PyPI

1. remove existing source distribution:

   rm -fr dist/*
   

2. Build source distribution:

   python setup.py sdist bdist_wheel
   

3. Deploy to Test PyPi:

   twine upload -r testpypi dist/*
   

4. Verity the library at https://test.pypi.org/project/dbt-teradata/.
5. Deploy to PyPi:

   twine upload dist/*
   

6. Verify at https://pypi.org/project/dbt-teradata/

PyPi recognizes pre-release versioning conventions and will label "pre-releases" as-such.

GitHub

1. Click the Create a new release link on the project homepage in GitHub
2. Type v{semantic_version} as the "tag version" (e.g., v0.18.0rc2)
3. Leave the "target" as main
4. Type dbt-teradata {semantic_version} as the "release title" (e.g. dbt-teradata 0.18.0rc2)
5. For pre-releases:
   • leave the description blank
   • Tick the "this is a pre-release" checkbox
6. Click the "publish release" button