SIG Addons Releases

April 17, 2023 ยท View on GitHub

TFX Addons follows Semantic Versioning 2.0 strategy.

Minor automatic release from main

  1. Trigger Create Minor Release workflow and ensure it runs to completion.
  2. Find created draft release.
    • Add updates for new features, enhancements, bug fixes
    • Add contributors using git shortlog <last-version>..HEAD -s
  3. Publish release.
    • Check PyPI to ensure release candidate has been released.
    • Send email to mailing list for vote.
  4. Find the minor version PR created above and merge it.

Major/Minor releases

  1. Create new rX.Y branch on https://github.com/tensorflow/tfx-addons from main.
  2. Update version.py in rX.Y branch.
    • Set the correct version and suffix in version.py.
    • Ensure the proper minimum and maximum tested versions of TFX are set in version.py.
    • Ensure proper supported python libraries are set in version.py.
  3. Create a new release from rX.Y branch. Create a tag with vX.Y.Z name.
    • Add updates for new features, enhancements, bug fixes
    • Add contributors using git shortlog <last-version>..HEAD -s
  4. Create a new PR and merge an increase of _MINOR_VERSION number in main to get ready for next release.

Patch releases

  1. Cherry-pick commits to rX.Y branch. Release team can just port PR by commenting "/cherry-pick rX.Y" in a merged PR.
  2. Create new PR with increasing _PATCH_VERSION in version.py against rX.Y branch.
    • Set the correct version and suffix in version.py.
    • Ensure the proper minimum and maximum tested versions of TFX are set in version.py.
    • Ensure proper supported python libraries are set in version.py.
  3. Create a new release from rX.Y branch. Create a tag with vX.Y.Z name.
    • Add updates for new features, enhancements, bug fixes
    • Add contributors using git shortlog <last-version>..HEAD -s

SIG Addons Release Team

Current Release Team:

  • Hannes Hapke - @hanneshapke
  • Gerard Casas Saez - @casassg