[docs] Update documentation for features from 2026-05-29#1556
Open
danielmeppiel wants to merge 1 commit into
Open
[docs] Update documentation for features from 2026-05-29#1556danielmeppiel wants to merge 1 commit into
danielmeppiel wants to merge 1 commit into
Conversation
…place doctor - Add reference/cli/doctor.md: new CLI reference for top-level apm doctor - Update reference/cli/marketplace.md: mark apm marketplace doctor as deprecated, point to apm doctor - Update reference/cli/install.md: document verbose perf summary output and discovery caching/skip-dir behaviour added in #1538 - Update producer/publish-to-a-marketplace.md: use apm doctor in the validate-before-you-ship snippet - Update packages/apm-guide skills/apm-usage/commands.md: add apm doctor row, mark marketplace doctor deprecated Refs #1539 (apm doctor promotion), #1538 (install perf) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
danielmeppiel
added
automation
Contributor
There was a problem hiding this comment.
Pull request overview
This documentation-only PR updates the APM docs and packaged usage guide for the newly promoted apm doctor command and recent apm install --verbose performance diagnostics.
Changes:
- Adds a CLI reference page for
apm doctor. - Marks
apm marketplace doctoras deprecated and points users toapm doctor. - Documents install discovery caching, verbose perf output, and skipped discovery directories.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/reference/cli/doctor.md |
Adds the new top-level doctor command reference. |
docs/src/content/docs/reference/cli/marketplace.md |
Documents apm marketplace doctor as deprecated. |
docs/src/content/docs/reference/cli/install.md |
Expands install diagnostics and discovery performance documentation. |
docs/src/content/docs/producer/publish-to-a-marketplace.md |
Updates the marketplace publishing validation snippet to use apm doctor. |
packages/apm-guide/.apm/skills/apm-usage/commands.md |
Updates the APM usage skill command reference for doctor/deprecation guidance. |
Copilot's findings
- Files reviewed: 5/5 changed files
- Comments generated: 5
| | git | `git` binary is on PATH and executable. | | ||
| | network | `github.com` is reachable via HTTPS. | | ||
| | auth | An auth token is available (GitHub PAT or `gh` CLI token). | | ||
| | gh CLI | `gh` is installed and authenticated. | |
Comment on lines
+30
to
+32
| | format coverage | All declared primitive types have a registered integrator. | | ||
| | duplicate names | No two packages declare the same primitive name in the same target scope. | | ||
| | version alignment | CLI version matches the lockfile schema version. | |
| - **Enterprise marketplace gate.** When installing from a `*.ghe.com` marketplace, bare cross-repo `repo:` fields (e.g. `repo: owner/repo`) are refused before any network request runs, preventing dependency-confusion attacks. Host-qualify the field to proceed: `repo: corp.ghe.com/owner/repo` for an enterprise dep, or `repo: github.com/owner/repo` for a declared cross-host dep. | ||
| - **Security scan.** Source files are scanned for hidden Unicode and other tag-character / bidi-override patterns before deployment. Critical findings block the package; the install exits `1`. Use `--force` to deploy anyway, or run `apm audit --strip` first to remediate. | ||
| - **Diagnostic summary.** Output is grouped at the end (collisions, replacements, warnings, errors) instead of inline. Use `--verbose` to expand individual file paths. | ||
| - **Diagnostic summary.** Output is grouped at the end (collisions, replacements, warnings, errors) instead of inline. Use `--verbose` to expand individual file paths and to surface a perf summary line (walks, file matches, cache hits) at the end of the run -- useful when diagnosing slow installs on large monorepos. |
| - **Security scan.** Source files are scanned for hidden Unicode and other tag-character / bidi-override patterns before deployment. Critical findings block the package; the install exits `1`. Use `--force` to deploy anyway, or run `apm audit --strip` first to remediate. | ||
| - **Diagnostic summary.** Output is grouped at the end (collisions, replacements, warnings, errors) instead of inline. Use `--verbose` to expand individual file paths. | ||
| - **Diagnostic summary.** Output is grouped at the end (collisions, replacements, warnings, errors) instead of inline. Use `--verbose` to expand individual file paths and to surface a perf summary line (walks, file matches, cache hits) at the end of the run -- useful when diagnosing slow installs on large monorepos. | ||
| - **Discovery caching.** `discover_primitives` is memoized per unique base directory within a single `apm install` invocation. Multi-target installs reuse the same walk result instead of re-walking the tree once per target. The cache is reset at the start of each `apm install` run. |
| - **Diagnostic summary.** Output is grouped at the end (collisions, replacements, warnings, errors) instead of inline. Use `--verbose` to expand individual file paths. | ||
| - **Diagnostic summary.** Output is grouped at the end (collisions, replacements, warnings, errors) instead of inline. Use `--verbose` to expand individual file paths and to surface a perf summary line (walks, file matches, cache hits) at the end of the run -- useful when diagnosing slow installs on large monorepos. | ||
| - **Discovery caching.** `discover_primitives` is memoized per unique base directory within a single `apm install` invocation. Multi-target installs reuse the same walk result instead of re-walking the tree once per target. The cache is reset at the start of each `apm install` run. | ||
| - **Skip directories.** The following directories are never walked during primitive discovery: `node_modules`, `.git`, `__pycache__`, `vendor`, `third_party`, `Pods`, `bower_components`, `jspm_packages`, `.gradle`, `target`, `.next`, `.nuxt`, `.cache`, `.turbo`. If your project stores primitives inside one of these paths, relocate them. |
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.
Documentation Updates - 2026-05-30
This PR updates the documentation based on features merged on 2026-05-29.
Features Documented
apm doctorpromoted to top-level command (from feat(cli): promote 'marketplace doctor' to top-level 'apm doctor' (+ workflow discoverability) #1539)apm marketplace doctordeprecated in favour ofapm doctor(from feat(cli): promote 'marketplace doctor' to top-level 'apm doctor' (+ workflow discoverability) #1539)apm install --verbosenow shows a perf summary; discovery caching and expanded skip dirs (from perf(install): memoize discovery, drop per-file resolve, expand skip dirs (#1533) #1538)Changes Made
docs/src/content/docs/reference/cli/doctor.md-- new CLI reference page for the top-levelapm doctorcommand, covering synopsis, all 8 checks, options, exit codes, and related links.docs/src/content/docs/reference/cli/marketplace.md-- markedapm marketplace doctoras deprecated in the synopsis and the subcommand section; added a note pointing toapm doctor.docs/src/content/docs/reference/cli/install.md-- expanded the Diagnostic summary bullet to document the verbose perf output ([#] Perf:lines), the discovery memoization behaviour, and the expandedDEFAULT_SKIP_DIRSlist.docs/src/content/docs/producer/publish-to-a-marketplace.md-- replacedapm marketplace doctorwithapm doctorin the validate-before-you-ship snippet.packages/apm-guide/.apm/skills/apm-usage/commands.md-- addedapm doctorrow to the diagnostics table; markedapm marketplace doctoras deprecated.Merged PRs Referenced
Notes
docs/src/content/docs/guides/operating-installed-context.mdwas already created as part of feat(cli): promote 'marketplace doctor' to top-level 'apm doctor' (+ workflow discoverability) #1539 itself and needed no further edits.Add this agentic workflows to your repo
To install this agentic workflow, run