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

Automated Version Bumping (CI/CD)

Version bumping is fully automated via GitHub Actions. On every push to main:

1. Analyzes commits using Conventional Commits:

   • feat: → Minor bump (0.1.x → 0.2.0)
   • fix:, perf:, refactor: → Patch bump (0.1.3 → 0.1.4)
   • feat!:, BREAKING CHANGE: → Major bump (0.x.x → 1.0.0)

2. Auto-updates:

   • Cargo.toml version
   • CHANGELOG.md with categorized changes
   • Creates git tag v0.1.4

3. Triggers release pipeline → builds binaries, Docker images, publishes to crates.io

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 (if needed)

# 1. Update version
cargo set-version 0.1.4

# 2. Update CHANGELOG.md

# 3. Commit and tag
git add Cargo.toml Cargo.lock CHANGELOG.md
git commit -m "chore(release): bump version to 0.1.4"
git tag -a v0.1.4 -m "Release v0.1.4"
git push && git push --tags

Quick Commands

make version          # Show current version info
cargo pkgid           # Show package identifier with version

Essential Commands

Development Commands

• Start development: make dev or cargo run (auto-loads config/gateway.yaml)
• Build: cargo build --all-features
• Test: cargo test --all-features
• Lint: cargo clippy --all-targets --all-features -- -D warnings
• Format: cargo fmt --all
• Quick start: make start (fastest way to start the gateway)