Skip to content

RELEASE_GUIDE.md

Latest commit

 

History

History
121 lines (91 loc) · 3.18 KB

RELEASE_GUIDE.md

File metadata and controls

121 lines (91 loc) · 3.18 KB

Release Guide

This guide documents the steps to release a new version of TensorZero.

You can inspect the Git SHA used to build a particular image tag with: docker image inspect tensorzero/ui:latest | jq '.[0].Config.Labels["org.opencontainers.image.revision"]'

Versioning

TensorZero follows CalVer for versioning. The format is YYYY.MM.PATCH (e.g. 2025.01.0, 2025.01.1).

Important

Make sure to update every instance of the version in the codebase.

The version is referenced in multiple places, including the client's pyproject.toml and the gateway's status.rs.

Python Client

The Python client is published to PyPI via GitHub Actions automatically when a new release is made.

Gateway Docker Container

Before building the Docker container for the first time, you need to set up your container builder:

docker buildx create \
  --name container-builder \
  --driver docker-container \
  --use \
  --bootstrap

Every time you want to build the Docker container, you need to run from the root of the repository:

DOCKER_BUILDKIT=1 docker buildx build \
  --platform linux/amd64,linux/arm64 \
  -t tensorzero/gateway:latest \
  -t tensorzero/gateway:XXXX.XX.X \
  -f gateway/Dockerfile \
  --attest type=provenance,mode=max \
  --attest type=sbom \
  --push \
  .

Important

Make sure to replace the XXXX.XX.X placeholder with the actual version of the Docker container you are building.

UI Docker Container

Before building the Docker container for the first time, you need to set up your container builder:

docker buildx create \
  --name container-builder \
  --driver docker-container \
  --use \
  --bootstrap

Every time you want to build the Docker container, you need to run from the root of the repository:

DOCKER_BUILDKIT=1 docker buildx build \
  --platform linux/amd64,linux/arm64 \
  -t tensorzero/ui:latest \
  -t tensorzero/ui:XXXX.XX.X \
  -f ui/Dockerfile \
  --attest type=provenance,mode=max \
  --attest type=sbom \
  --push \
  .

Important

Make sure to replace the XXXX.XX.X placeholder with the actual version of the Docker container you are building.

Evaluations Docker container

Before building the Docker container for the first time, you need to set up your container builder:

docker buildx create \
  --name container-builder \
  --driver docker-container \
  --use \
  --bootstrap

Every time you want to build the Docker container, you need to run from the root of the repository:

DOCKER_BUILDKIT=1 docker buildx build \
  --platform linux/amd64,linux/arm64 \
  -t tensorzero/evaluations:latest \
  -t tensorzero/evaluations:XXXX.XX.X \
  -f evaluations/Dockerfile \
  --attest type=provenance,mode=max \
  --attest type=sbom \
  --push \
  .

Important

Make sure to replace the XXXX.XX.X placeholder with the actual version of the Docker container you are building.

Documentation

Run the following command and create a pull request from the new branch into docs:

git fetch origin
git switch -c sync-docs-$(date +%Y%m%d-%H%M) origin/main
git push -u origin HEAD

Release Notes

Make sure to tag a release in the GitHub repository.