chore(e2e): untrack gateway config and document e2e test location - #31914
Conversation
Stop tracking tests/e2e/gateway/litellm-config.yml so the local proxy config stays on the machine Add a note to CLAUDE.md that new e2e tests belong in tests/e2e/ and must follow that directory's conventions
56e7d3d to
4b0f4e7
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Greptile SummaryThis chore PR stops tracking the machine-local e2e proxy config (
Confidence Score: 4/5Safe to merge; the changes are purely housekeeping with no production code touched. The .gitignore and CLAUDE.md changes are straightforward and correct. The only gap is that removing the tracked config without shipping a companion example file leaves first-time contributors with no starting point for gateway/litellm-config.yml, which CONTRIBUTING.md says is required to bring the e2e stack up. tests/e2e/.gitignore — consider whether a gateway/litellm-config.yml.example should accompany this change.
|
| Filename | Overview |
|---|---|
| CLAUDE.md | Adds one-line note directing e2e tests to tests/e2e/ with a reference to that directory's CLAUDE.md, which exists and is comprehensive. |
| tests/e2e/.gitignore | New .gitignore that excludes gateway/litellm-config.yml from tracking; correct and minimal. |
| tests/e2e/gateway/litellm-config.yml | 237-line proxy config deleted from git tracking; no example/template replacement provided for first-time contributors who need this file to run e2e tests. |
Comments Outside Diff (1)
-
tests/e2e/.gitignore, line 1 (link)Missing starter template for gitignored config
CONTRIBUTING.mdexplicitly tells contributors to bring updocker-composefrom this directory, which servesgateway/litellm-config.yml. With the file deleted and gitignored, anyone cloning the repo fresh hits a missing-file error before they can run a single test. Consider adding agateway/litellm-config.yml.example(or similar) that holds the skeleton with placeholder env-var references so new contributors have a starting point andCONTRIBUTING.mdcan point at it.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Reviews (1): Last reviewed commit: "chore(e2e): untrack gateway config and d..." | Re-trigger Greptile
…tellm_remove_gateway_config # Conflicts: # tests/e2e/gateway/litellm-config.yml
|
added config directly to helm chart - please use management endpoints to add new models for e2e tests. |
Ship a docker-compose.yml that starts the proxy with a throwaway Postgres and Redis and inlines the proxy config with example models, so contributors can bring up a local gateway with nothing but a .env. Update CONTRIBUTING.md to match the inline-config flow
![veria-ai[bot]](https://avatars.githubusercontent.com/in/1723776?s=60&v=4){kind=small}
PR overviewAll previously flagged issues have been addressed. No open security concerns remain on this pull request. Security reviewNo open security issues remain on this pull request. Fixed/addressed: 1 · PR risk: 0/10 |
2 participants
Stop tracking tests/e2e/gateway/litellm-config.yml so the local proxy config stays on the machine
Add a self-contained docker-compose.yml to tests/e2e/ that starts the proxy with a throwaway Postgres and Redis. The proxy config is inlined in the compose file under
configswith example models (gpt-5.5, claude-haiku-4-5, gemini-2.5-flash, openai-text-embedding-3-small) whose keys come from a local .env, so contributors can bring up a gateway for the e2e suites with nothing but their provider keys. CONTRIBUTING.md in that directory now documents the flow: write the .env, docker compose up -d, run a suite, docker compose down -vAdd a note to CLAUDE.md that new e2e tests belong in tests/e2e/ and must follow that directory's conventions
Relevant issues
Linear ticket
Pre-Submission checklist
Please complete all items before asking a LiteLLM maintainer to review your PR
@greptileaiand received a Confidence Score of at least 4/5 before requesting a maintainer reviewDelays in PR merge?
If you're seeing a delay in your PR being merged, ping the LiteLLM Team on Slack (#pr-review).
Screenshots / Proof of Fix
From tests/e2e/ with a .env holding OPENAI_API_KEY, ANTHROPIC_API_KEY, GEMINI_API_KEY:
Type
🧹 Refactoring
📖 Documentation
Changes