Skip to content

[docs-patrol] Update AGENTS.md packaging guidance for optional PACKAGES defaults #14877

@github-actions

Description

@github-actions

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

  • Update AGENTS.md packaging section to state that PACKAGES is optional and defaults to tar.gz for non-Windows platforms and zip for Windows (based on PLATFORMS).

What is this? | From workflow: Docs Patrol

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

  • expires on Jun 18, 2026, 3:30 PM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions