litellm-rs: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Version Management

Releasing (manual, two steps)

Merging to main does not bump the version or publish anything. Unreleased commits accumulate until a maintainer cuts a release:

1. Bump: run the Version Bump workflow (gh workflow run version-bump.yml -f bump_type=auto). It reads Conventional Commits since the last tag:

   • feat: → minor (0.9.x → 0.10.0)
   • fix:, perf:, refactor: → patch (0.9.0 → 0.9.1)
   • feat!: / BREAKING CHANGE: → major; requires -f confirm_breaking_changes=true

   It updates Cargo.toml, Cargo.lock and CHANGELOG.md, pushes the bump commit to main, and pushes tag vX.Y.Z.

2. Publish: the tag is pushed with GITHUB_TOKEN, which does not trigger other workflows, so start the release pipeline on the tag yourself: gh workflow run release.yml --ref vX.Y.Z. It builds binaries and Docker images and publishes to crates.io. A tag pushed from a maintainer's machine triggers release.yml automatically instead.

Commit Message Format

<type>(<scope>): <description>

[optional body]

[optional footer]

Types: feat, fix, docs, style, refactor, perf, test, chore

Examples:

git commit -m "feat(router): add weighted load balancing"     # → minor
git commit -m "fix(auth): resolve JWT validation issue"       # → patch
git commit -m "feat!: redesign provider interface"            # → major

Version Info in Code

Access build information programmatically:

use litellm_rs::{VERSION, GIT_HASH, full_version, build_info};

println!("Version: {}", VERSION);           // "0.1.4"
println!("Full: {}", full_version());       // "0.1.4-a1b2c3d"
println!("Info: {}", build_info());         // "0.1.4-a1b2c3d (built 1704067200 with rustc 1.87)"

Manual Release (without the Version Bump workflow)