Recent code changes in the repository have introduced documentation drift. The following change needs a corresponding documentation update.
Changes Requiring Documentation Updates
1. AGENTS.md still states PACKAGES is required, but code now defaults it
Commit(s):
What changed:
dev-tools/mage/settings.go now defaults package types when PACKAGES is unset (tar.gz for non-Windows platforms, zip for Windows).
magefile.go comment was updated accordingly:
magefile.go:614-615 says PACKAGES is an override and defaults apply when unset.
- In the same commit, docs were updated in:
README.md
docs/test-framework-dev-guide.md
- But
AGENTS.md was not updated.
Documentation impact:
AGENTS.md:89 currently says: "The PACKAGES env var is required".
- This is now incorrect and can mislead contributors about required packaging inputs.
- Update
AGENTS.md packaging section to match the current behavior (optional PACKAGES; platform-derived defaults when unset).
Suggested Actions
What is this? | From workflow: Docs Patrol
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
Recent code changes in the repository have introduced documentation drift. The following change needs a corresponding documentation update.
Changes Requiring Documentation Updates
1.
AGENTS.mdstill statesPACKAGESis required, but code now defaults itCommit(s):
28d14a834172ac2a58c351aa6c4bc14de2dc5df6What changed:
dev-tools/mage/settings.gonow defaults package types whenPACKAGESis unset (tar.gzfor non-Windows platforms,zipfor Windows).magefile.gocomment was updated accordingly:magefile.go:614-615saysPACKAGESis an override and defaults apply when unset.README.mddocs/test-framework-dev-guide.mdAGENTS.mdwas not updated.Documentation impact:
AGENTS.md:89currently says: "ThePACKAGESenv var is required".AGENTS.mdpackaging section to match the current behavior (optionalPACKAGES; platform-derived defaults when unset).Suggested Actions
AGENTS.mdpackaging section to state thatPACKAGESis optional and defaults totar.gzfor non-Windows platforms andzipfor Windows (based onPLATFORMS).What is this? | From workflow: Docs Patrol
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.