|
| 1 | +# LiteLLM Release Notes Generation Instructions |
| 2 | + |
| 3 | +This document provides comprehensive instructions for AI agents to generate release notes for LiteLLM following the established format and style. |
| 4 | + |
| 5 | +## Required Inputs |
| 6 | + |
| 7 | +1. **Release Version** (e.g., `v1.76.3-stable`) |
| 8 | +2. **PR Diff/Changelog** - List of PRs with titles and contributors |
| 9 | +3. **Previous Version Commit Hash** - To compare model pricing changes |
| 10 | +4. **Reference Release Notes** - Previous release notes to follow style/format |
| 11 | + |
| 12 | +## Step-by-Step Process |
| 13 | + |
| 14 | +### 1. Initial Setup and Analysis |
| 15 | + |
| 16 | +```bash |
| 17 | +# Check git diff for model pricing changes |
| 18 | +git diff <previous_commit_hash> HEAD -- model_prices_and_context_window.json |
| 19 | +``` |
| 20 | + |
| 21 | +**Key Analysis Points:** |
| 22 | +- New models added (look for new entries) |
| 23 | +- Deprecated models removed (look for deleted entries) |
| 24 | +- Pricing updates (look for cost changes) |
| 25 | +- Feature support changes (tool calling, reasoning, etc.) |
| 26 | + |
| 27 | +### 2. Release Notes Structure |
| 28 | + |
| 29 | +Follow this exact structure based on `docs/my-website/release_notes/v1.76.1-stable/index.md`: |
| 30 | + |
| 31 | +```markdown |
| 32 | +--- |
| 33 | +title: "v1.76.X-stable - [Key Theme]" |
| 34 | +slug: "v1-76-X" |
| 35 | +date: YYYY-MM-DDTHH:mm:ss |
| 36 | +authors: [standard author block] |
| 37 | +hide_table_of_contents: false |
| 38 | +--- |
| 39 | + |
| 40 | +## Deploy this version |
| 41 | +[Docker and pip installation tabs] |
| 42 | + |
| 43 | +## Key Highlights |
| 44 | +[3-5 bullet points of major features] |
| 45 | + |
| 46 | +## Major Changes |
| 47 | +[Critical changes users need to know] |
| 48 | + |
| 49 | +## Performance Improvements |
| 50 | +[Performance-related changes] |
| 51 | + |
| 52 | +## New Models / Updated Models |
| 53 | +[Detailed model tables and provider updates] |
| 54 | + |
| 55 | +## LLM API Endpoints |
| 56 | +[API-related features and fixes] |
| 57 | + |
| 58 | +## Management Endpoints / UI |
| 59 | +[Admin interface and management changes] |
| 60 | + |
| 61 | +## Logging / Guardrail Integrations |
| 62 | +[Observability and security features] |
| 63 | + |
| 64 | +## Performance / Loadbalancing / Reliability improvements |
| 65 | +[Infrastructure improvements] |
| 66 | + |
| 67 | +## General Proxy Improvements |
| 68 | +[Other proxy-related changes] |
| 69 | + |
| 70 | +## New Contributors |
| 71 | +[List of first-time contributors] |
| 72 | + |
| 73 | +## Full Changelog |
| 74 | +[Link to GitHub comparison] |
| 75 | +``` |
| 76 | + |
| 77 | +### 3. Categorization Rules |
| 78 | + |
| 79 | +**Performance Improvements:** |
| 80 | +- RPS improvements |
| 81 | +- Memory optimizations |
| 82 | +- CPU usage optimizations |
| 83 | +- Timeout controls |
| 84 | +- Worker configuration |
| 85 | + |
| 86 | +**New Models/Updated Models:** |
| 87 | +- Extract from model_prices_and_context_window.json diff |
| 88 | +- Create tables with: Provider, Model, Context Window, Input Cost, Output Cost, Features |
| 89 | +- Group by provider |
| 90 | +- Note pricing corrections |
| 91 | +- Highlight deprecated models |
| 92 | + |
| 93 | +**Provider Features:** |
| 94 | +- Group by provider (Gemini, OpenAI, Anthropic, etc.) |
| 95 | +- Link to provider docs: `../../docs/providers/[provider_name]` |
| 96 | +- Separate features from bug fixes |
| 97 | + |
| 98 | +**API Endpoints:** |
| 99 | +- Images API |
| 100 | +- Video Generation (if applicable) |
| 101 | +- Responses API |
| 102 | +- Passthrough endpoints |
| 103 | +- General chat completions |
| 104 | + |
| 105 | +**UI/Management:** |
| 106 | +- Authentication changes |
| 107 | +- Dashboard improvements |
| 108 | +- Team management |
| 109 | +- Key management |
| 110 | + |
| 111 | +**Integrations:** |
| 112 | +- Logging providers (Datadog, Braintrust, etc.) |
| 113 | +- Guardrails |
| 114 | +- Cost tracking |
| 115 | +- Observability |
| 116 | + |
| 117 | +### 4. Documentation Linking Strategy |
| 118 | + |
| 119 | +**Link to docs when:** |
| 120 | +- New provider support added |
| 121 | +- Significant feature additions |
| 122 | +- API endpoint changes |
| 123 | +- Integration additions |
| 124 | + |
| 125 | +**Link format:** `../../docs/[category]/[specific_doc]` |
| 126 | + |
| 127 | +**Common doc paths:** |
| 128 | +- `../../docs/providers/[provider]` - Provider-specific docs |
| 129 | +- `../../docs/image_generation` - Image generation |
| 130 | +- `../../docs/video_generation` - Video generation (if exists) |
| 131 | +- `../../docs/response_api` - Responses API |
| 132 | +- `../../docs/proxy/logging` - Logging integrations |
| 133 | +- `../../docs/proxy/guardrails` - Guardrails |
| 134 | +- `../../docs/pass_through/[provider]` - Passthrough endpoints |
| 135 | + |
| 136 | +### 5. Model Table Generation |
| 137 | + |
| 138 | +From git diff analysis, create tables like: |
| 139 | + |
| 140 | +```markdown |
| 141 | +| Provider | Model | Context Window | Input ($/1M tokens) | Output ($/1M tokens) | Features | |
| 142 | +| -------- | ----- | -------------- | ------------------- | -------------------- | -------- | |
| 143 | +| OpenRouter | `openrouter/openai/gpt-4.1` | 1M | $2.00 | $8.00 | Chat completions with vision | |
| 144 | +``` |
| 145 | + |
| 146 | +**Extract from JSON:** |
| 147 | +- `max_input_tokens` → Context Window |
| 148 | +- `input_cost_per_token` × 1,000,000 → Input cost |
| 149 | +- `output_cost_per_token` × 1,000,000 → Output cost |
| 150 | +- `supports_*` fields → Features |
| 151 | +- Special pricing fields (per image, per second) for generation models |
| 152 | + |
| 153 | +### 6. PR Categorization Logic |
| 154 | + |
| 155 | +**By Keywords in PR Title:** |
| 156 | +- `[Perf]`, `Performance`, `RPS` → Performance Improvements |
| 157 | +- `[Bug]`, `[Bug Fix]`, `Fix` → Bug Fixes section |
| 158 | +- `[Feat]`, `[Feature]`, `Add support` → Features section |
| 159 | +- `[Docs]` → Documentation (usually exclude from main sections) |
| 160 | +- Provider names (Gemini, OpenAI, etc.) → Group under provider |
| 161 | + |
| 162 | +**By PR Content Analysis:** |
| 163 | +- New model additions → New Models section |
| 164 | +- UI changes → Management Endpoints/UI |
| 165 | +- Logging/observability → Logging/Guardrail Integrations |
| 166 | +- Rate limiting/budgets → Performance/Reliability |
| 167 | +- Authentication → Management Endpoints |
| 168 | + |
| 169 | +### 7. Writing Style Guidelines |
| 170 | + |
| 171 | +**Tone:** |
| 172 | +- Professional but accessible |
| 173 | +- Focus on user impact |
| 174 | +- Highlight breaking changes clearly |
| 175 | +- Use active voice |
| 176 | + |
| 177 | +**Formatting:** |
| 178 | +- Use consistent markdown formatting |
| 179 | +- Include PR links: `[PR #XXXXX](https://github.com/BerriAI/litellm/pull/XXXXX)` |
| 180 | +- Use code blocks for configuration examples |
| 181 | +- Bold important terms and section headers |
| 182 | + |
| 183 | +**Warnings/Notes:** |
| 184 | +- Add warning boxes for breaking changes |
| 185 | +- Include migration instructions when needed |
| 186 | +- Provide override options for default changes |
| 187 | + |
| 188 | +### 8. Quality Checks |
| 189 | + |
| 190 | +**Before finalizing:** |
| 191 | +- Verify all PR links work |
| 192 | +- Check documentation links are valid |
| 193 | +- Ensure model pricing is accurate |
| 194 | +- Confirm provider names are consistent |
| 195 | +- Review for typos and formatting issues |
| 196 | + |
| 197 | +### 9. Common Patterns to Follow |
| 198 | + |
| 199 | +**Performance Changes:** |
| 200 | +```markdown |
| 201 | +- **+400 RPS Performance Boost** - Description - [PR #XXXXX](link) |
| 202 | +``` |
| 203 | + |
| 204 | +**New Models:** |
| 205 | +Always include pricing table and feature highlights |
| 206 | + |
| 207 | +**Breaking Changes:** |
| 208 | +```markdown |
| 209 | +:::warning |
| 210 | +This release has a known issue... |
| 211 | +::: |
| 212 | +``` |
| 213 | + |
| 214 | +**Provider Features:** |
| 215 | +```markdown |
| 216 | +- **[Provider Name](../../docs/providers/provider)** |
| 217 | + - Feature description - [PR #XXXXX](link) |
| 218 | +``` |
| 219 | + |
| 220 | +### 10. Missing Documentation Check |
| 221 | + |
| 222 | +**Review for missing docs:** |
| 223 | +- New providers without documentation |
| 224 | +- New API endpoints without examples |
| 225 | +- Complex features without guides |
| 226 | +- Integration setup instructions |
| 227 | + |
| 228 | +**Flag for documentation needs:** |
| 229 | +- New provider integrations |
| 230 | +- Significant API changes |
| 231 | +- Complex configuration options |
| 232 | +- Migration requirements |
| 233 | + |
| 234 | +## Example Command Workflow |
| 235 | + |
| 236 | +```bash |
| 237 | +# 1. Get model changes |
| 238 | +git diff <commit> HEAD -- model_prices_and_context_window.json |
| 239 | + |
| 240 | +# 2. Analyze PR list for categorization |
| 241 | +# 3. Create release notes following template |
| 242 | +# 4. Link to appropriate documentation |
| 243 | +# 5. Review for missing documentation needs |
| 244 | +``` |
| 245 | + |
| 246 | +## Output Requirements |
| 247 | + |
| 248 | +- Follow exact markdown structure from reference |
| 249 | +- Include all PR links and contributors |
| 250 | +- Provide accurate model pricing tables |
| 251 | +- Link to relevant documentation |
| 252 | +- Highlight breaking changes with warnings |
| 253 | +- Include deployment instructions |
| 254 | +- End with full changelog link |
| 255 | + |
| 256 | +This process ensures consistent, comprehensive release notes that help users understand changes and upgrade smoothly. |
0 commit comments