Releasing¶

This guide describes how to release a new version of es-translator. Only maintainers with publish access can perform releases.

Prerequisites¶

Before releasing, ensure you have:

• Push access to the GitHub repository
• PyPI credentials configured: poetry config pypi-token.pypi <your-token>
• Docker Hub credentials (for Docker image publishing)

Release Checklist¶

• All tests pass (make test)
• Linting passes (make lint)
• Documentation is up to date

Release Process¶

1. Verify Tests Pass¶

make lint
make test

2. Bump Version¶

Use semantic versioning targets:

# 1.0.0 -> 1.0.1
make patch

# 1.0.0 -> 1.1.0
make minor

# 1.0.0 -> 2.0.0
make major

This will:

1. Update version in pyproject.toml
2. Create a commit: build: bump to <version>
3. Create a git tag with the version

To set a specific version:

make set-version CURRENT_VERSION=1.2.3

3. Push to GitHub¶

git push origin master
git push origin --tags

4. Publish to PyPI¶

make distribute

This builds and uploads the package to PyPI.

5. Publish Docker Image¶

# First-time setup for multi-arch builds
make docker-setup-multiarch

# Build and push
make docker-publish

This builds and pushes images with both version tag and latest.

6. Update Documentation¶

make publish-doc

Version Numbering¶

We follow Semantic Versioning:

Makefile Reference¶

Troubleshooting¶

PyPI Upload Fails¶

Ensure your token is configured:

poetry config pypi-token.pypi <your-token>

Docker Push Fails¶

Login to Docker Hub:

docker login

Multi-arch Build Fails¶

Setup buildx:

make docker-setup-multiarch