Skip to content

Commit 56c9d8b

Browse files
committed
[Misc] Record how to regenerate the lockfile when upgrading a JavaScript dependency
* dependencies: the pnpm and node versions the build uses are pinned in the xwiki-commons parent pom, so the lockfile must be regenerated with that pnpm and then deduped — not with whatever pnpm is on PATH.
1 parent 7211880 commit 56c9d8b

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

xwiki/okf/conventions/dependencies.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,15 @@ for that dependency — except for the license criterion.
2727

2828
Upgrading dependencies is a separate flow: upgrade PRs (including Renovate's) have per-ecosystem
2929
default assignees — see the `xwiki-pull-request` skill.
30+
31+
## Upgrading a JavaScript dependency
32+
33+
The branch pins its own toolchain: `pnpm.version` and `node.version` are properties of the
34+
**xwiki-commons parent pom**, and the build runs pnpm through that pin, not the one on your `PATH`.
35+
Regenerate the lockfile with **that** version (`npx pnpm@<pnpm.version> install --lockfile-only`) —
36+
a newer pnpm resolves peers differently and produces a lockfile the build then rewrites. Then run
37+
`pnpm dedupe --lockfile-only` with the same version, so the upgrade does not leave duplicated
38+
versions behind; expect it to touch entries unrelated to the dependency you bumped.
39+
40+
Whether the bump is `[Misc]` or needs an issue, and what that issue's description holds, are in
41+
[[commit-messages]] and [[jira]].

0 commit comments

Comments
 (0)