Repository navigation
docs(#3067): add dependency removal cleanup checklist - #3071
Conversation
Add a 'Dependency Removal Cleanup' subsection to the existing Dependency Update Process guidance in AGENTS.md. The new section covers the steps needed when removing a package: grepping the entire repo for stale references, checking for package-specific environment variables, cleaning up docs/scripts/configs, and verifying no runtime imports remain. This addresses a process gap where the existing checklist covered adding and updating dependencies but not the removal case, which led to stale references being left behind (e.g., PR #3057 removed litellm but left references in 6+ files). Closes #3067
|
Important Review skippedBot user detected. To trigger a single review, invoke the
|
|
🤖 Finished Review · ✅ Success · Started 4:32 PM UTC · Completed 4:42 PM UTC Commit: Runtime: pi · Model: opus → claude-opus-4-6 · Effort: high · Cost: $2.30 |
ReviewFindingsMedium
Low
Labels: PR adds documentation guidance to AGENTS.md for dependency removal cleanup. |
| 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' \ |
There was a problem hiding this comment.
[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.
|
🤖 Finished Retro · ✅ Success · Started 10:10 AM UTC · Completed 10:18 AM UTC Commit: Runtime: pi · Model: opus → claude-opus-4-6 · Effort: high · Cost: $1.70 |
Retro: PR #3071 — Dependency removal cleanup checklistTimeline
What went well
What could improve
Existing issues corroborated
Proposals filed
|
Description
Adds a Dependency Removal Cleanup subsection to the Dependency Update Process guidance in AGENTS.md. The existing checklist covers adding and updating dependencies (pyproject.toml, uv.lock, Konflux, Tekton) but did not address the removal case. This gap led to stale references being left behind when packages were dropped (e.g., PR #3057 removed litellm but left references in 6+ files, tracked in #3066).
The new section instructs contributors to:
Type of change
Tools used to create PR
Related Tickets and Documents
Checklist before requesting a review
Testing
This is a documentation-only change to AGENTS.md. No code or tests are affected. Verified the markdown renders correctly and the new subsection is properly nested under the existing Dependency Update Process (Konflux) section.
Closes #3067
Post-script verification
agent/3067-dependency-removal-guidance)401a7b55cd7f1561ef69e67ecbf9279e06c8e017..HEAD)