Skip to content

[docs] Update documentation for features from 2026-05-10#1265

Open
danielmeppiel wants to merge 1 commit into
mainfrom
docs/update-commands-2026-05-11-921a7f0917c021b7
Open

[docs] Update documentation for features from 2026-05-10#1265
danielmeppiel wants to merge 1 commit into
mainfrom
docs/update-commands-2026-05-11-921a7f0917c021b7

Conversation

@danielmeppiel
Copy link
Copy Markdown
Collaborator

Documentation Updates - 2026-05-10

This PR updates the documentation based on features merged in the last 24 hours.

Features Documented

Changes Made

  • Updated docs/src/content/docs/reference/cli-commands.md:
    • Replaced the old apm update (CLI self-updater) section with the new dependency-update command: resolves apm.yml against latest refs, shows a structured plan, prompts [y/N] before any mutation. Flags: --yes, --dry-run, --verbose.
    • Added new apm self-update section covering the old CLI self-updater behavior (including --check, version-checking, distributor guidance, and manual update instructions).
    • Added --frozen flag to apm install options: CI-safe install that exits 1 if apm.lock.yaml is missing or out of sync with apm.yml. Noted mutual exclusion with --update.
    • Marked --update flag on apm install as deprecated; users should prefer apm update.
    • Clarified --force help text: does NOT refresh refs.
    • Added no-op nudge note to apm install Diff-Aware Installation section.

Merged PRs Referenced

Notes

The packages/apm-guide/.apm/skills/apm-usage/commands.md resource file was already up to date with apm update and apm self-update entries (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.

  • #1149 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".

To allow these resources, lower min-integrity in your GitHub frontmatter:

tools:
  github:
    min-integrity: approved  # merged | approved | unapproved | none

Generated by Daily Documentation Updater · ● 1.2M ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/daily-doc-updater.md@b87234850bf9664d198f28a02df0f937d0447295
  • expires on May 13, 2026, 6:08 AM UTC

… (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>
Copilot AI review requested due to automatic review settings May 11, 2026 06:08
@danielmeppiel danielmeppiel added automation Deprecated: use type/automation. Kept for issue history; will be removed in milestone 0.10.0. documentation Deprecated: use type/docs. Kept for issue history; will be removed in milestone 0.10.0. labels May 11, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 update as the dependency refresh command (plan + consent gate) and adds a new apm self-update section for CLI binary updates.
  • Adds --frozen to apm install and marks --update as deprecated in favor of apm update.
  • Notes the no-op install hint that points users to apm update when 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 still Run 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation Deprecated: use type/automation. Kept for issue history; will be removed in milestone 0.10.0. documentation Deprecated: use type/docs. Kept for issue history; will be removed in milestone 0.10.0.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Install locked until apm.lockfile.yaml removed

2 participants