[docs] Update documentation for features from 2026-05-10#1265
Open
danielmeppiel wants to merge 1 commit into
Open
[docs] Update documentation for features from 2026-05-10#1265danielmeppiel wants to merge 1 commit into
danielmeppiel wants to merge 1 commit into
Conversation
… (from #1244) - apm update now documents the new dependency-update command (resolves apm.yml against latest refs, shows a plan, prompts [y/N] before mutating anything). Supports --yes, --dry-run, --verbose. - New apm self-update section documents the CLI self-updater (previously apm update). Includes --check flag, version-checking behavior, and manual update instructions. - apm install --frozen flag added: CI-safe install that exits 1 when apm.lock.yaml is missing or any direct apm.yml dep is absent. Mutually exclusive with --update. - apm install --update marked deprecated; prefer apm update. - apm install --force help text clarified: does NOT refresh refs. - No-op nudge: apm install on a satisfied lockfile now notes 'Run apm update to check for newer versions.' Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the CLI command reference to document the newly introduced dependency lifecycle command surface (apm update, apm self-update, and apm install --frozen) and related install messaging.
Changes:
- Documents
apm updateas the dependency refresh command (plan + consent gate) and adds a newapm self-updatesection for CLI binary updates. - Adds
--frozentoapm installand marks--updateas deprecated in favor ofapm update. - Notes the no-op install hint that points users to
apm updatewhen the lockfile is already satisfied.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/reference/cli-commands.md | Updates CLI reference docs for apm update / apm self-update semantics, apm install --frozen, and the satisfied-lockfile hint. |
Copilot's findings
Comments suppressed due to low confidence (1)
docs/src/content/docs/reference/cli-commands.md:867
- The version-checking snippet says
Run apm self-update to upgrade, but the current startup notification hint is stillRun apm update to upgrade. Please align the docs with the current CLI output (or update the code and then keep the docs consistent with it).
[!] A new version of APM is available: 0.7.0 (current: 0.6.3)
Run apm self-update to upgrade
- Files reviewed: 1/1 changed files
- Comments generated: 4
| @@ -790,42 +792,78 @@ apm unpack bundle.tar.gz --force | |||
| - Verification checks that all `deployed_files` from the bundle lockfile are present in the bundle | |||
| - The bundle's `apm.lock.yaml` is metadata only — it is **not** copied to the output directory | |||
| - APM packages removed from `apm.yml` have their deployed files cleaned up on the next full `apm install` | ||
| - APM packages whose ref/version changed in `apm.yml` are re-downloaded automatically (no `--update` needed) | ||
| - `--force` remains available for full overwrite/reset scenarios | ||
| - When the lockfile already satisfies the manifest and no flags were passed, `apm install` prints an info line: `Run 'apm update' to check for newer versions.` |
|
|
||
| **Behavior:** | ||
| - Resolves all `apm.yml` deps (including `latest` and branch refs) against their current remote state | ||
| - Prints a structured plan grouped into: added / updated / removed / unchanged |
Comment on lines
+828
to
+829
| > with a one-line deprecation banner. This back-compat shim will be removed in the | ||
| > next minor release -- use `apm self-update` explicitly to update the CLI. |
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-10
This PR updates the documentation based on features merged in the last 24 hours.
Features Documented
apm update-- new dependency lifecycle command (from Add 'apm update' command and '--frozen' install flag (closes #1203) #1244)apm self-update-- CLI self-updater renamed fromapm update(from Add 'apm update' command and '--frozen' install flag (closes #1203) #1244)apm install --frozen-- CI-safe install flag (from Add 'apm update' command and '--frozen' install flag (closes #1203) #1244)apm installon a satisfied lockfile now hintsapm update(from Add 'apm update' command and '--frozen' install flag (closes #1203) #1244)Changes Made
docs/src/content/docs/reference/cli-commands.md:apm update(CLI self-updater) section with the new dependency-update command: resolvesapm.ymlagainst latest refs, shows a structured plan, prompts[y/N]before any mutation. Flags:--yes,--dry-run,--verbose.apm self-updatesection covering the old CLI self-updater behavior (including--check, version-checking, distributor guidance, and manual update instructions).--frozenflag toapm installoptions: CI-safe install that exits 1 ifapm.lock.yamlis missing or out of sync withapm.yml. Noted mutual exclusion with--update.--updateflag onapm installas deprecated; users should preferapm update.--forcehelp text: does NOT refresh refs.apm installDiff-Aware Installation section.Merged PRs Referenced
apm updatecommand and--frozeninstall flag (closes Install locked until apm.lockfile.yaml removed #1203)unmanaged_fileswhen child omits block (bug fix; no user-facing API change to document)Notes
The
packages/apm-guide/.apm/skills/apm-usage/commands.mdresource file was already up to date withapm updateandapm self-updateentries (likely updated in the same PR). No changes needed there.Note
🔒 Integrity filter blocked 1 item
The following item was blocked because it doesn't meet the GitHub integrity level.
search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".To allow these resources, lower
min-integrityin your GitHub frontmatter: