Skip to content

Commit 448777a

Browse files
docs(outdated): clarify monorepo tag pattern matching for virtual subdirectory deps
- Document that {name} in patterned tags is derived from virtual_path basename for virtual subdirectory packages (e.g. packages/my-pkg). - Add example row showing monorepo virtual dep in sample output. - Add concrete apm.yml example with path: for monorepo deps. Follow-up to #1504 and #1893.
1 parent 7d71ce3 commit 448777a

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

docs/src/content/docs/reference/cli/outdated.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ apm outdated [OPTIONS]
1818
`apm outdated` reads `apm.lock.yaml` and queries each remote to detect staleness:
1919

2020
- **Plain tag-pinned deps** (e.g. `v1.2.3` or `1.2.3`): semver compare against the latest matching remote tag.
21-
- **Patterned tag-pinned deps** (e.g. `my-pkg_v1.2.3`, `my-pkg--v1.2.3`, or `my-pkg-v1.2.3`): semver compare against the latest tag matching the package-specific pattern inferred from the locked ref.
21+
- **Patterned tag-pinned deps** (e.g. `my-pkg_v1.2.3`, `my-pkg--v1.2.3`, or `my-pkg-v1.2.3`): semver compare against the latest tag matching the package-specific pattern inferred from the locked ref. For virtual subdirectory packages (installed via `path:` in `apm.yml`), `{name}` is derived from the final path segment, so a dep with `path: packages/my-pkg` resolves tags like `my-pkg_v1.2.3`.
2222
- **Full-SHA revision-pinned deps**: compare the pinned SHA against the commit behind the latest annotated semver tag. Branches and lightweight tags are ignored.
2323
- **Branch-pinned deps** (e.g. `main`): compare the locked commit SHA against the remote branch tip.
2424
- **Default-branch deps** (no ref): compare against `main`/`master` tip.
@@ -57,6 +57,7 @@ Sample output:
5757
acme/prompt-pack main 9c1ab2f0 outdated git branch
5858
acme/sha-pinned a1b2c3d4 v2.0.0 (9e8d7c6b) outdated git tags
5959
acme/lint-rules v0.3.0 v0.3.0 up-to-date git tags
60+
org/monorepo/packages/my-pkg my-pkg_v1.0.0 my-pkg_v1.1.0 outdated git tags
6061
nadavy/e2e-demo 1.0.1 1.1.1 outdated registry: corp
6162
microsoft/apm-review-panel 0.1.1 0.1.2 outdated registry: corp (lockfile)
6263
acme/deploy-helpers stable - unknown registry (pinned ref)
@@ -79,6 +80,17 @@ Show available tags for outdated packages:
7980
apm outdated --verbose
8081
```
8182

83+
Monorepo dependency installed via `path:` (tag name derived from virtual path):
84+
85+
```yaml
86+
# apm.yml
87+
- git: https://github.com/org/monorepo.git
88+
path: packages/my-pkg
89+
ref: my-pkg_v1.0.0
90+
```
91+
92+
With a newer tag `my-pkg_v1.1.0` on the remote, `apm outdated` reports it as outdated.
93+
8294
Use 8 parallel checks for large dependency sets:
8395

8496
```bash

0 commit comments

Comments
 (0)