fix: correct stale tar.gz/tarball refs and publish UX gaps after zip default#1815
Closed
nadav-y wants to merge 1 commit into
Closed
fix: correct stale tar.gz/tarball refs and publish UX gaps after zip default#1815nadav-y wants to merge 1 commit into
nadav-y wants to merge 1 commit into
Conversation
…default (#1779) apm publish and apm pack --archive now produce .zip by default (#1720). This commit cleans all remaining stale references and fixes five UX gaps surfaced in the post-merge panel review. Stale reference cleanup: - docs/reference/cli/publish.md: .tar.gz -> .zip, --tarball -> --zip, tarball root -> archive root, remove tar czf example, fix ASCII - docs/guides/registries.md: same fixes + add cross-platform zip-build example in Custom layouts section - docs/reference/registry-http-api.md: correct publish format note - packages/apm-guide/.apm/skills/apm-usage/package-authoring.md: .tar.gz -> .zip, tarball -> archive, --tarball -> --zip - packages/apm-guide/.apm/skills/apm-usage/workflow.md: .zip as default - src/apm_cli/commands/publish.py: module docstring + em dash + tarball - src/apm_cli/deps/registry/extractor.py: "tarball sha256 mismatch" -> "archive sha256 mismatch" - src/apm_cli/deps/registry/resolver.py: em dash + tar.gz default Panel review fixes (post-merge): - publish.py _PUBLISH_HELP: add --package to all four examples (required=True flag was missing from every example -- copy-paste crash) - publish.py line 272: replace em dash with -- in Forbidden ClickException (user-visible on 403 responses; prior commit missed this one) - resolver.py lines 98, 104, 363, 369: replace "registry tarball for" with "registry archive for" in RegistryResolutionError strings (same class of fix as extractor.py, missed in first pass) - package-authoring.md: add --package to all publish examples - registries.md Custom layouts: add --package + python -m zipfile build step (Windows users had no actionable guidance after tar czf example was removed) - publish.md --zip row: add "(renamed from --tarball in v0.20.0)" migration note so CI pipelines using --tarball get a recovery path Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Collaborator
Author
|
Duplicate -- this commit was already merged via #1779. Closing. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aligns registry publish/install UX and docs with the post-v0.20.0 .zip default, removing stale .tar.gz/--tarball references and fixing user-facing messaging gaps (notably --package in examples).
Changes:
- Updated
apm publishhelp/docs/examples to consistently include the required--packageflag and use--zip/.zip. - Normalized registry resolver/extractor wording from “tarball” to “archive” where appropriate (including sha256 mismatch messaging).
- Refreshed registry HTTP API + registries guide text/examples to match
application/zipdefaults and provide a cross-platform zip build snippet.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/apm_cli/deps/registry/resolver.py | Updates resolver error strings/comments to refer to “archive” and zip default/legacy tar.gz. |
| src/apm_cli/deps/registry/extractor.py | Renames sha256 mismatch message from “tarball” to “archive”. |
| src/apm_cli/commands/publish.py | Updates command doc/help text, examples, and user-visible strings for zip + --package. |
| packages/apm-guide/.apm/skills/apm-usage/workflow.md | Updates install bundle format description to include .zip default + legacy .tar.gz. |
| packages/apm-guide/.apm/skills/apm-usage/package-authoring.md | Updates publish workflow docs to use --package and .zip/--zip. |
| docs/src/content/docs/reference/registry-http-api.md | Updates publish-time format guidance and example Content-Type to zip. |
| docs/src/content/docs/reference/cli/publish.md | Updates CLI reference for --zip, adds rename note, and fixes examples/output snippets. |
| docs/src/content/docs/guides/registries.md | Updates registries guide publish section, replacing tarball guidance with zip + cross-platform build step. |
Comment on lines
+1
to
4
| """``apm publish`` command -- upload a packed zip archive to a registry. | ||
|
|
||
| Implements docs/proposals/registry-api.md §5.3: | ||
| ``PUT /v1/packages/{owner}/{repo}/versions/{version}`` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.tar.gz/--tarballreferences with.zip/--zipfollowing the v0.20.0 default change (feat(pack): switch --archive to .zip and add --archive-format zip|tar.gz #1720)--packageto allapm publishhelp examples (required flag was missing from every example)ClickExceptionmessage (user-visible on 403 responses)RegistryResolutionErrorstrings--packageand a cross-platform zip-build step to the Custom layouts section of the registries guide(renamed from --tarball in v0.20.0)migration note topublish.md --ziprowTest plan
apm publish --helpshows--packagein all examplestar.gz/--tarball/ em dash in user-visible strings (grepclean)🤖 Generated with Claude Code