[docs] Update documentation for Artifactory archive entry download (2026-04-05)#579
Conversation
…ckages Add a new 'Archive Entry Download' subsection to the registry proxy authentication guide explaining that single-file primitives are now Also add the corresponding CHANGELOG entry under Unreleased. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
danielmeppiel
added
automation
documentation
There was a problem hiding this comment.
Pull request overview
Documents the recently merged Artifactory “archive entry download” optimization so users understand why single-file primitives can download faster via a registry proxy, and updates release notes accordingly.
Changes:
- Added an “Archive Entry Download (virtual file packages)” subsection under the Artifactory registry proxy docs.
- Added a changelog entry describing the optimization.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/getting-started/authentication.md | Adds user-facing documentation for the Artifactory archive entry download behavior and fallback. |
| CHANGELOG.md | Adds an Unreleased entry for the feature (currently duplicates the already-released #525 note). |
Copilot's findings
- Files reviewed: 2/2 changed files
- Comments generated: 2
| ### Added | ||
|
|
||
| - Artifactory Archive Entry Download for virtual file packages: single-file primitives (`.prompt.md`, `.agent.md`, etc.) are now fetched via the `!/{path}` entry API instead of a full archive download, with transparent fallback on unsupported Artifactory versions (#525) | ||
|
|
There was a problem hiding this comment.
The [Unreleased] section now includes an entry for feature PR #525, but the changelog already documents #525 under the released 0.8.10 section (and with a different category: Changed). This will cause duplicate/misleading release notes. Consider removing this new Unreleased entry; if the intent is to track this documentation-only PR, add a concise entry that references this PR number instead of #525.
| ### Added | |
| - Artifactory Archive Entry Download for virtual file packages: single-file primitives (`.prompt.md`, `.agent.md`, etc.) are now fetched via the `!/{path}` entry API instead of a full archive download, with transparent fallback on unsupported Artifactory versions (#525) |
| ### Archive Entry Download (virtual file packages) | ||
|
|
||
| When downloading virtual file packages (`.prompt.md`, `.agent.md`, and similar single-file primitives) through an Artifactory proxy, APM uses the **Archive Entry Download API** to fetch only the specific file instead of the full archive. | ||
|
|
||
| The entry URL follows the Artifactory pattern: | ||
|
|
||
| ``` | ||
| GET {archive_url}!/{repo}-{ref}/{file_path} | ||
| ``` | ||
|
|
||
| This avoids downloading a multi-MB archive just to extract a single small file. If the entry API returns a 404, a connection error, or is unsupported by the Artifactory version in use, APM falls back to the standard full-archive download transparently -- no configuration required. | ||
|
|
There was a problem hiding this comment.
This new subsection documents the Artifactory archive-entry optimization in the public docs, but the corresponding apm-usage skill content likely also needs the same update so CLI/help guidance stays consistent (see packages/apm-guide/.apm/skills/apm-usage/authentication.md, which currently only mentions proxy env vars). Consider adding a matching brief subsection there as well.
Documentation Updates - 2026-04-05
This PR updates documentation based on the feature merged in the last 24 hours.
Features Documented
Changes Made
docs/src/content/docs/getting-started/authentication.mdto add a new Archive Entry Download subsection under the "Registry proxy (Artifactory)" section, explaining the single-file fetch optimization and transparent fallback behaviour.CHANGELOG.mdto add theAddedentry under[Unreleased]for this feature.Merged PRs Referenced
Summary of the feature
Virtual file packages (
.prompt.md,.agent.md, etc.) downloaded through an Artifactory proxy now use the Archive Entry Download API (!/{repo}-{ref}/{path}) to fetch only the specific file, avoiding a full multi-MB archive download. If the entry API is unavailable (404, connection error, or unsupported Artifactory version), APM falls back to the standard full-archive download transparently — no configuration required.