RELEASE.md

SQLAlchemy-Utils Release Process

This document outlines the process for creating a new release of SQLAlchemy-Utils.

Prerequisites

• Access to the GitHub repository with push permissions
• PyPI account with API token for the project
• uv package manager installed
• gh CLI tool installed (optional, for GitHub releases)

Release Process

1. Prepare the Release

1. Update CHANGES.rst

   • Move items from "Unreleased changes" section to a new version section
   • Follow the existing format: X.Y.Z (YYYY-MM-DD)
   • Add a new "Unreleased changes" section

2. Update version in pyproject.toml

   # Edit pyproject.toml and update the version field
   version = "X.Y.Z"

3. Commit the changes

   git add CHANGES.rst pyproject.toml
   git commit -m "Bump version to X.Y.Z"
   git push origin master

2. Create Git Tag

git tag -a X.Y.Z -m "Release version X.Y.Z"
git push origin X.Y.Z

3. Build and Publish to PyPI

1. Build the package

   uv build

2. Publish to PyPI

   uv publish --token pypi-your-api-token-here

   Alternatively, set the token as an environment variable:

   export UV_PUBLISH_TOKEN="pypi-your-api-token-here"
   uv publish

4. Create GitHub Release

gh release create X.Y.Z --title "X.Y.Z" --notes-from-tag

Or create the release manually on GitHub using the tag.

Version Numbering

This project follows Semantic Versioning:

• MAJOR version for incompatible API changes
• MINOR version for backwards-compatible functionality additions
• PATCH version for backwards-compatible bug fixes