Skip to content

docs(#3067): add dependency removal cleanup checklist #3071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tisnik merged 1 commit into from
Oct 30, 2026
+26 −0
Merged

docs(#3067): add dependency removal cleanup checklist #3071

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,3 +458,29 @@ single PR to avoid iterative CI failures.
available as transitive dependencies of the removed/changed package.
6. **Run `uv run make verify`** to confirm linting and type checking pass with
the updated dependencies.

### Dependency Removal Cleanup

When removing a dependency from `pyproject.toml`, follow the standard update
process above **and** perform these additional cleanup steps to eliminate stale
references:

1. **Grep the entire repo for the removed package name** to find stale
references in source files, docs, scripts, configs, and examples:
```bash
grep -rn '<package_name>' --include='*.py' --include='*.md' \

@fullsend-ai-review fullsend-ai-review Bot Oct 29, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] edge-case

The example grep command in the new Dependency Removal Cleanup section omits --include=.sh and --include=.json, yet the repository contains 10+ shell scripts (e.g., scripts/entrypoint.sh, scripts/generate_local_run.sh) and JSON config files (e.g., .github/renovate.json) where a removed package name could appear as a reference. A developer following this checklist literally would miss those file types.

--include='*.yaml' --include='*.yml' --include='*.toml' \
--include='*.txt' --include='Makefile' --include='Containerfile'
```
2. **Check for package-specific environment variables** — removed packages
often have env vars that should also be cleaned up (e.g., `LITELLM_DROP_PARAMS`
for litellm). Search for these across the repo.
3. **Remove or update all stale references** found in:
- README and other documentation files
- Makefile and build scripts
- Containerfile and docker-compose files
- Example and default configuration files
- Inline code comments referencing the removed package
4. **Verify no runtime imports remain** — confirm that no Python source file
still imports the removed package (including conditional or try/except
imports).
Loading