Repository navigation
Update AGENTS.md for Python bundles and snapshots - #8432
Conversation
There was a problem hiding this comment.
💬 Approved with comments — This is a documentation-only change. One WARNING: the rule for when to upload a new bundle leaves out the packages metadata in build/python_metadata.bzl, which also changes what goes into a bundle. One INFO: the new table contradicts the overview line above it about what a bundle contains.
Findings: 1 warning · 1 info (2 are inline comments on the diff)
The decision is advisory: this review is a comment and never approves, blocks or requests changes on the pull request.
🔧 Fix with your agent
Paste the following into your coding agent to investigate and fix these issues.
Fix the following code review issues found in pull request #8432.
Before making changes, review each issue and present a brief summary table:
- For each finding, state whether you agree, disagree, or need clarification
- If you disagree (e.g., the fix would require disproportionate changes
for minimal ROI, or the finding is factually incorrect), explain why
- If you need to clarify something before deciding, ask those questions
- Then share your plan for which issues to tackle and in what order
## WARNING (1)
### [Documentation] Upload rule leaves out the `packages` / lock-file metadata in `build/python_metadata.bzl`, which also changes what goes into the bundle
- **File:** src/pyodide/AGENTS.md:42
## INFO (1)
### [Documentation] New table's list of bundle contents contradicts the overview at line 5, which says the bundle contains only the patched glue
- **File:** src/pyodide/AGENTS.md:36
📝 Documentation: ⚠️ 1 warning · 1 info
The rule for when to upload a bundle misses the metadata that picks its packages, and the new table contradicts the overview line.
Recommendation: 📝 Minor Comments
- [WARNING] Upload rule leaves out the
packages/ lock-file metadata inbuild/python_metadata.bzl, which also changes what goes into the bundle (src/pyodide/AGENTS.md:42) - [INFO] New table's list of bundle contents contradicts the overview at line 5, which says the bundle contains only the patched glue (
src/pyodide/AGENTS.md:36)
View full review
src/pyodide/AGENTS.md:41-42: The upload rule says that onlybundle/and the Pyodide release inPYODIDE_VERSIONSchange a bundle's contents. That is not the whole list._packages_tag_for_version()inbundle/python_bundles.bzl:38-47reads thepackagesfield ofBUNDLE_VERSION_INFOinbuild/python_metadata.bzl, around lines 119 and 147. That field picks the lock file and wheels that get packed intopython_packages.bin(python_bundles.bzl:145-173). ThePYTHON_LOCKFILEStags in the same file are tied to it as well. Anyone who changes this metadata and follows the doc as written will not upload a new bundle, so the released bundles will be out of date.src/pyodide/AGENTS.md:36: The new table listspyodide.asm.wasm,python_stdlib.zipandpython_packages.binas part of the bundle, which matchespython_bundles.bzl. The overview at line 5 still says the bundle "contains only the patched Emscripten glue". One of the two should be changed so they agree, and the overview is the one that is wrong.
Reviewed commit: 327966ca
Update AGENTS.md to explain how Python bundles and snapshots are generated, and when they should be re-generated.