1215 Release Notes Generation Instructions 0dc50c74

LiteLLM Release Notes Generation Instructions

This document provides comprehensive instructions for AI agents to generate release notes for LiteLLM following the established format and style.

Required Inputs

1. Release Version (e.g., v1.77.3-stable)
2. PR Diff/Changelog - List of PRs with titles and contributors
3. Previous Version Commit Hash - To compare model pricing changes
4. Reference Release Notes - Use recent stable releases (v1.76.3-stable, v1.77.2-stable) as templates for consistent formatting

Step-by-Step Process

1. Initial Setup and Analysis

# Check git diff for model pricing changes
git diff <previous_commit_hash> HEAD -- model_prices_and_context_window.json

Key Analysis Points:

• New models added (look for new entries)
• Deprecated models removed (look for deleted entries)
• Pricing updates (look for cost changes)
• Feature support changes (tool calling, reasoning, etc.)

2. Release Notes Structure

Follow this exact structure based on recent stable releases (v1.76.3-stable, v1.77.2-stable, v1.77.5-stable):

---
title: "v1.77.X-stable - [Key Theme]"
slug: "v1-77-X"
date: YYYY-MM-DDTHH:mm:ss
authors: [standard author block]
hide_table_of_contents: false
---

## Deploy this version
[Docker and pip installation tabs]

## Key Highlights
[3-5 bullet points of major features - prioritize MCP OAuth 2.0, scheduled key rotations, and major model updates]

## New Providers and Endpoints

### New Providers
[Table with Provider, Supported Endpoints, Description columns]

### New LLM API Endpoints
[Optional table for new endpoint additions with Endpoint, Method, Description, Documentation columns]

## New Models / Updated Models
#### New Model Support
[Model pricing table]

#### Features
[Provider-specific features organized by provider]

### Bug Fixes
[Provider-specific bug fixes organized by provider]

## LLM API Endpoints
#### Features
[API-specific features organized by API type]

#### Bugs
[General bug fixes]

## Management Endpoints / UI
#### Features
[UI and management features - group by functionality like Proxy CLI Auth, Virtual Keys, Models + Endpoints]

#### Bugs
[Management-related bug fixes]

## AI Integrations

### Logging
[Logging integrations organized by provider with proper doc links, includes General subsection]

### Guardrails
[Guardrail-specific features and fixes]

### Prompt Management
[Prompt management integrations like BitBucket]

### Secret Managers
[Secret manager integrations - AWS, HashiCorp Vault, CyberArk, etc.]

## Spend Tracking, Budgets and Rate Limiting
[Cost tracking, service tier pricing, rate limiting improvements]

## MCP Gateway
[MCP-specific features, OAuth 2.0, configuration improvements]

## Performance / Loadbalancing / Reliability improvements
[Infrastructure improvements, memory fixes, performance optimizations]

## Documentation Updates
[Documentation improvements, guides, corrections - separate section for visibility]

## New Contributors
[List of first-time contributors]

## Full Changelog
[Link to GitHub comparison]

3. Categorization Rules

Performance Improvements:

• RPS improvements
• Memory optimizations
• CPU usage optimizations
• Timeout controls
• Worker configuration
• Memory leak fixes
• Cache performance improvements
• Database connection management
• Dependency management (fastuuid, etc.)
• Configuration management

New Models/Updated Models:

• Extract from model_prices_and_context_window.json diff
• Create tables with: Provider, Model, Context Window, Input Cost, Output Cost, Features
• Structure:
  • #### New Model Support - pricing table
  • #### Features - organized by provider with documentation links
  • ### Bug Fixes - provider-specific bug fixes
  • #### New Provider Support - major new provider integrations
• Group by provider with proper doc links: **[Provider Name](../../docs/providers/[provider])**
• Use bullet points under each provider for multiple features
• Separate features from bug fixes clearly

LLM API Endpoints:

• Structure:
  • #### Features - organized by API type (Responses API, Batch API, etc.)
  • #### Bugs - general bug fixes under General category
• API Categories:
  • Responses API
  • Batch API
  • CountTokens API
  • Images API
  • Video Generation (if applicable)
  • General (miscellaneous improvements)
• Use proper documentation links for each API type

UI/Management:

• Authentication changes
• Dashboard improvements
• Team management
• Key management
• Proxy CLI authentication and improvements
• Virtual key management and scheduled rotations
• SSO configuration fixes
• Admin settings updates
• Management routes and endpoints

AI Integrations:

• Structure:
  • ### Logging - organized by integration provider with proper doc links, includes General subsection
  • ### Guardrails - guardrail-specific features and fixes
  • ### Prompt Management - prompt management integrations
  • ### Secret Managers - secret manager integrations
• Logging Categories:
  • DataDog - group all DataDog-related changes
  • Langfuse - Langfuse-specific features
  • Prometheus - monitoring improvements
  • PostHog - observability integration
  • SQS - SQS logging features
  • Opik - Opik integration improvements
  • Arize Phoenix - Arize Phoenix integration
  • General - miscellaneous logging features like callback controls, sensitive data masking
  • Other logging providers with proper doc links
• Guardrail Categories:
  • LakeraAI, Presidio, Noma, Grayswan, IBM Guardrails, and other guardrail providers
• Prompt Management:
  • BitBucket, GitHub, and other prompt management integrations
  • Prompt versioning, testing, and UI features
• Secret Managers:
  • AWS Secrets Manager - AWS secret manager features
  • HashiCorp Vault - Vault integrations
  • CyberArk - CyberArk integrations
  • General - cross-secret-manager features
• Use bullet points under each provider for multiple features
• Separate logging, guardrails, prompt management, and secret managers clearly

4. Documentation Linking Strategy

Link to docs when:

• New provider support added
• Significant feature additions
• API endpoint changes
• Integration additions

Link format: ../../docs/[category]/[specific_doc]

Common doc paths:

• ../../docs/providers/[provider] - Provider-specific docs
• ../../docs/image_generation - Image generation
• ../../docs/video_generation - Video generation (if exists)
• ../../docs/response_api - Responses API
• ../../docs/proxy/logging - Logging integrations
• ../../docs/proxy/guardrails - Guardrails
• ../../docs/pass_through/[provider] - Passthrough endpoints

5. Model Table Generation

From git diff analysis, create tables like:

| Provider | Model | Context Window | Input ($/1M tokens) | Output ($/1M tokens) | Features |
| -------- | ----- | -------------- | ------------------- | -------------------- | -------- |
| OpenRouter | `openrouter/openai/gpt-4.1` | 1M | $2.00 | $8.00 | Chat completions with vision |

Extract from JSON:

• max_input_tokens → Context Window
• input_cost_per_token × 1,000,000 → Input cost
• output_cost_per_token × 1,000,000 → Output cost
• supports_* fields → Features
• Special pricing fields (per image, per second) for generation models

6. PR Categorization Logic

By Keywords in PR Title:

• [Perf], Performance, RPS → Performance Improvements
• [Bug], [Bug Fix], Fix → Bug Fixes section
• [Feat], [Feature], Add support → Features section
• [Docs] → Documentation Updates section
• Provider names (Gemini, OpenAI, etc.) → Group under provider
• MCP, oauth, Model Context Protocol → MCP Gateway
• service_tier, priority, cost tracking → Spend Tracking, Budgets and Rate Limiting

By PR Content Analysis:

• New model additions → New Models section
• UI changes → Management Endpoints/UI
• Logging/observability → Logging/Guardrail/Prompt Management Integrations
• Rate limiting/budgets → Spend Tracking, Budgets and Rate Limiting
• Authentication → Management Endpoints/UI
• MCP-related changes → MCP Gateway
• Documentation updates → Documentation Updates
• Performance/memory fixes → Performance/Loadbalancing/Reliability improvements

Special Categorization Rules:

• Service tier pricing (OpenAI priority/flex) → Spend Tracking section (NOT provider features)
• Cost breakdown in logging → Spend Tracking section
• MCP configuration/OAuth → MCP Gateway (NOT General Proxy Improvements)
• All documentation PRs → Documentation Updates section for visibility
• Callback controls/logging features → AI Integrations > Logging > General
• Secret manager features → AI Integrations > Secret Managers
• Video generation tag-based routing → LLM API Endpoints > Video Generation API

7. Writing Style Guidelines

Tone:

• Professional but accessible
• Focus on user impact
• Highlight breaking changes clearly
• Use active voice

Formatting:

• Use consistent markdown formatting
• Include PR links: [PR #XXXXX](https://github.com/BerriAI/litellm/pull/XXXXX)
• Use code blocks for configuration examples
• Bold important terms and section headers

Warnings/Notes:

• Add warning boxes for breaking changes
• Include migration instructions when needed
• Provide override options for default changes

8. Quality Checks

Before finalizing:

• Verify all PR links work
• Check documentation links are valid
• Ensure model pricing is accurate
• Confirm provider names are consistent
• Review for typos and formatting issues
• Count PRs by section - Provide final count like:

  ## MM/DD/YYYY
  * New Models / Updated Models: XX
  * LLM API Endpoints: XX
  * Management Endpoints / UI: XX
  * Logging / Guardrail / Prompt Management Integrations: XX
  * Spend Tracking, Budgets and Rate Limiting: XX
  * MCP Gateway: XX
  * Performance / Loadbalancing / Reliability improvements: XX
  * Documentation Updates: XX
  

9. Common Patterns to Follow

Performance Changes:

- **+400 RPS Performance Boost** - Description - [PR #XXXXX](link)

New Models: Always include pricing table and feature highlights

Breaking Changes:

:::warning
This release has a known issue...
:::

Provider Features (New Models / Updated Models section):

#### Features

- **[Provider Name](../../docs/providers/provider)**
    - Feature description - [PR #XXXXX](link)
    - Another feature description - [PR #YYYYY](link)

API Features (LLM API Endpoints section):

#### Features

- **[API Name](../../docs/api_path)**
    - Feature description - [PR #XXXXX](link)
    - Another feature - [PR #YYYYY](link)
- **General**
    - Miscellaneous improvements - [PR #ZZZZZ](link)

Integration Features (Logging / Guardrail Integrations section):

#### Features

- **[Integration Name](../../docs/proxy/logging#integration)**
    - Feature description - [PR #XXXXX](link)
    - Bug fix description - [PR #YYYYY](link)

Bug Fixes Pattern:

### Bug Fixes

- **[Provider/Component Name](../../docs/providers/provider)**
    - Bug fix description - [PR #XXXXX](link)

10. Missing Documentation Check

Review for missing docs:

• New providers without documentation
• New API endpoints without examples
• Complex features without guides
• Integration setup instructions

Flag for documentation needs:

• New provider integrations
• Significant API changes
• Complex configuration options
• Migration requirements

11. New Sections and Categories (Added in v1.77.5)

MCP Gateway Section:

• All MCP-related changes go here (not in General Proxy Improvements)
• OAuth 2.0 flow improvements
• MCP configuration and tools
• Server management features

Spend Tracking, Budgets and Rate Limiting Section:

• Service tier pricing (OpenAI priority/flex pricing)
• Cost tracking and breakdown features
• Rate limiting improvements (Parallel Request Limiter v3)
• Priority reservation fixes
• Metadata handling for rate limiting

Documentation Updates Section:

• Create separate section for all documentation improvements
• Include provider documentation fixes
• Model reference updates
• New guides and tutorials
• Documentation corrections and clarifications
• This gives documentation changes proper visibility

Management Endpoints / UI Grouping:

• Group related features under sub-categories:
  • Proxy CLI Auth - CLI authentication improvements
  • Virtual Keys - Key rotation and management
  • Models + Endpoints - Provider and endpoint management

AI Integrations Section Expansion:

• Renamed from "Logging / Guardrail / Prompt Management Integrations" to "AI Integrations"
• Structure with four main subsections:
  • Logging - with General subsection for miscellaneous logging features
  • Guardrails - separate from logging features
  • Prompt Management - BitBucket, GitHub integrations, versioning features
  • Secret Managers - AWS, HashiCorp Vault, CyberArk, etc.

New Providers and Endpoints Section:

• Add section after Key Highlights and before New Models / Updated Models
• Include tables for:
  • New Providers - Provider name, supported endpoints, description
  • New LLM API Endpoints (optional) - Endpoint, method, description, documentation link
• Only include major new provider integrations, not minor provider updates
• IMPORTANT: When adding new providers, also update provider_endpoints_support.json in the repository root (see Section 13)

12. Section Header Counts

Always include counts in section headers for:

• New Providers - Add count in parentheses: ### New Providers (X new providers)
• New LLM API Endpoints - Add count in parentheses: ### New LLM API Endpoints (X new endpoints)
• New Model Support - Add count in parentheses: #### New Model Support (X new models)

Format:

### New Providers (4 new providers)

| Provider | Supported LiteLLM Endpoints | Description |
| -------- | --------------------------- | ----------- |
...

### New LLM API Endpoints (2 new endpoints)

| Endpoint | Method | Description | Documentation |
| -------- | ------ | ----------- | ------------- |
...

#### New Model Support (32 new models)

| Provider | Model | Context Window | Input ($/1M tokens) | Output ($/1M tokens) | Features |
| -------- | ----- | -------------- | ------------------- | -------------------- | -------- |
...

Counting Rules:

• Count each row in the table (excluding the header row)
• For models, count each model entry in the pricing table
• For providers, count each new provider added
• For endpoints, count each new API endpoint added

13. Update provider_endpoints_support.json

When adding new providers or endpoints, you MUST also update provider_endpoints_support.json in the repository root.

This file tracks which endpoints are supported by each LiteLLM provider and is used to generate documentation.

Required Steps:

1. For each new provider added to the release notes, add a corresponding entry to provider_endpoints_support.json
2. For each new endpoint type added, update the schema comment and add the endpoint to relevant providers

Provider Entry Format:

"provider_slug": {
  "display_name": "Provider Name (`provider_slug`)",
  "url": "https://docs.litellm.ai/docs/providers/provider_slug",
  "endpoints": {
    "chat_completions": true,
    "messages": true,
    "responses": true,
    "embeddings": false,
    "image_generations": false,
    "audio_transcriptions": false,
    "audio_speech": false,
    "moderations": false,
    "batches": false,
    "rerank": false,
    "a2a": true
  }
}

Available Endpoint Types:

• chat_completions - /chat/completions endpoint
• messages - /messages endpoint (Anthropic format)
• responses - /responses endpoint (OpenAI/Anthropic unified)
• embeddings - /embeddings endpoint
• image_generations - /image/generations endpoint
• audio_transcriptions - /audio/transcriptions endpoint
• audio_speech - /audio/speech endpoint
• moderations - /moderations endpoint
• batches - /batches endpoint
• rerank - /rerank endpoint
• ocr - /ocr endpoint
• search - /search endpoint
• vector_stores - /vector_stores endpoint
• a2a - /a2a/{agent}/message/send endpoint (A2A Protocol)

Checklist:

• All new providers from release notes are added to provider_endpoints_support.json
• Endpoint support flags accurately reflect provider capabilities
• Documentation URL points to correct provider docs page

Example Command Workflow

# 1. Get model changes
git diff <commit> HEAD -- model_prices_and_context_window.json

# 2. Analyze PR list for categorization
# 3. Create release notes following template
# 4. Link to appropriate documentation
# 5. Review for missing documentation needs

Output Requirements

• Follow exact markdown structure from reference
• Include all PR links and contributors
• Provide accurate model pricing tables
• Link to relevant documentation
• Highlight breaking changes with warnings
• Include deployment instructions
• End with full changelog link

This process ensures consistent, comprehensive release notes that help users understand changes and upgrade smoothly.