fix: correct stale tar.gz and --tarball references after zip default#1779
Open
nadav-y wants to merge 2 commits into
Open
fix: correct stale tar.gz and --tarball references after zip default#1779nadav-y wants to merge 2 commits into
nadav-y wants to merge 2 commits into
Conversation
apm publish and apm pack --archive now produce .zip by default (landed in microsoft#1720). Update all remaining docs and source references that still described the old .tar.gz default or the removed --tarball flag: - docs/reference/cli/publish.md: {name}-{version}.tar.gz -> .zip, --tarball -> --zip, tarball root -> archive root, remove tar czf example, fix ellipsis and em dashes to ASCII - docs/guides/registries.md: same set of fixes in the registries guide - 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: mention .zip as default alongside legacy .tar.gz - 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: comment em dash + tar.gz default
nadav-y
requested review from
danielmeppiel and
sergio-sisternes-epam
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR cleans up stale .tar.gz / --tarball references after PR #1720 switched the default producer format to .zip, aligning docs and a few in-code strings/comments with the current packaging behavior.
Changes:
- Update publish/registry documentation to describe
.zipas the default archive and--zipas the override path. - Clarify the Registry HTTP API format expectations and backwards-compat acceptance for legacy tar.gz uploads.
- Rename/adjust a couple of in-code references from “tarball” to “archive” for accuracy.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
src/apm_cli/deps/registry/resolver.py |
Updates comment to reflect zip default + legacy tar.gz extraction support. |
src/apm_cli/deps/registry/extractor.py |
Renames sha256 mismatch message from “tarball” to “archive”. |
src/apm_cli/commands/publish.py |
Updates module docstring to refer to zip archive publish. |
packages/apm-guide/.apm/skills/apm-usage/workflow.md |
Documents .zip as default bundle format alongside legacy .tar.gz. |
packages/apm-guide/.apm/skills/apm-usage/package-authoring.md |
Updates registry publish packaging guidance to .zip / --zip. |
docs/src/content/docs/reference/registry-http-api.md |
Updates publish-format note and adds backwards-compat acceptance statement. |
docs/src/content/docs/reference/cli/publish.md |
Updates publish reference from tar.gz/--tarball to zip/--zip and ASCII punctuation. |
docs/src/content/docs/guides/registries.md |
Updates registry guide to reflect zip default and --zip. |
…, zip in HTTP API example
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
docs/reference/cli/publish.md:{name}-{version}.tar.gz->.zip,--tarball->--zip,tarball root->archive root, removedtar czfexample, fixed ellipsis and em dashes to ASCIIdocs/guides/registries.md: same fixes in the registries guidedocs/reference/registry-http-api.md: corrected publish format note (was incorrectly citingapm packtar.gz; now citesapm publishzip with backwards-compat note)packages/apm-guide/.apm/skills/apm-usage/package-authoring.md:.tar.gz->.zip,tarball->archive,--tarball->--zippackages/apm-guide/.apm/skills/apm-usage/workflow.md: mention.zipas default alongside legacy.tar.gzsrc/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: comment em dash + "tar.gz (default)"Context
PR #1720 switched
apm pack --archiveandapm publishto produce.zipby default and added--archive-format zip|tar.gz. These doc and source references were missed in that PR and still described the old.tar.gzdefault or the removed--tarballflag.Test plan
uv run --extra dev ruff check src/ tests/-- cleanuv run --extra dev ruff format --check src/ tests/-- cleanbash scripts/lint-auth-signals.sh-- cleanuv run pytest tests/unit tests/test_console.py-- 5358 passed, 1 pre-existing failure unrelated to this change