Files
setup-node/docs/adrs/0001-support-caching-deps-for-monorepos.md
T
Kai 96dd1b7824
e2e-cache / Test npm (Node 22, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test npm (Node 22, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test npm (Node 24, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test npm (Node 26, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test npm (Node 22, macos-latest) (push) Canceled after 0s
e2e-cache / Test npm (Node 22, windows-latest) (push) Canceled after 0s
e2e-cache / Test npm (Node 24, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test npm (Node 24, macos-latest) (push) Canceled after 0s
e2e-cache / Test npm (Node 24, windows-latest) (push) Canceled after 0s
e2e-cache / Test npm (Node 26, macos-latest) (push) Canceled after 0s
e2e-cache / Test npm (Node 26, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test npm (Node 26, windows-latest) (push) Canceled after 0s
e2e-cache / Test pnpm (Node 22, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test pnpm (Node 22, macos-latest) (push) Canceled after 0s
e2e-cache / Test pnpm (Node 22, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test pnpm (Node 22, windows-latest) (push) Canceled after 0s
e2e-cache / Test pnpm (Node 24, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test pnpm (Node 24, macos-latest) (push) Canceled after 0s
e2e-cache / Test pnpm (Node 24, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test pnpm (Node 24, windows-latest) (push) Canceled after 0s
e2e-cache / Test pnpm (Node 26, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test pnpm (Node 26, macos-latest) (push) Canceled after 0s
e2e-cache / Test pnpm (Node 26, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test pnpm (Node 26, windows-latest) (push) Canceled after 0s
e2e-cache / Test yarn 1 (Node 22, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test yarn 1 (Node 22, macos-latest) (push) Canceled after 0s
e2e-cache / Test yarn 1 (Node 22, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test yarn 1 (Node 22, windows-latest) (push) Canceled after 0s
e2e-cache / Test yarn 1 (Node 24, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test yarn 1 (Node 24, macos-latest) (push) Canceled after 0s
e2e-cache / Test yarn 1 (Node 24, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test yarn 1 (Node 24, windows-latest) (push) Canceled after 0s
e2e-cache / Test yarn 1 (Node 26, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test yarn 1 (Node 26, macos-latest) (push) Canceled after 0s
e2e-cache / Test yarn 1 (Node 26, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test yarn 1 (Node 26, windows-latest) (push) Canceled after 0s
e2e-cache / Test yarn 3 (Node 22, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test yarn 3 (Node 22, macos-latest) (push) Canceled after 0s
e2e-cache / Test yarn 3 (Node 24, macos-latest) (push) Canceled after 0s
e2e-cache / Test yarn 3 (Node 26, macos-latest) (push) Canceled after 0s
e2e-cache / Test yarn 3 (Node 26, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test yarn subprojects all locally managed (24) (push) Canceled after 0s
e2e-cache / Test yarn subprojects all locally managed (26) (push) Canceled after 0s
e2e-cache / Test yarn subprojects some locally managed (22) (push) Canceled after 0s
e2e-cache / Test yarn subprojects managed by git (22) (push) Canceled after 0s
e2e-cache / Test auto cache with top-level packageManager (22, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with top-level packageManager (24, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with top-level packageManager (26, windows-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with devEngines.packageManager (22, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test auto cache with devEngines.packageManager (22, macos-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with devEngines.packageManager (22, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with devEngines.packageManager (22, windows-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with devEngines.packageManager (24, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test auto cache with devEngines.packageManager (24, macos-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with devEngines.packageManager (24, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with devEngines.packageManager (24, windows-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with devEngines.packageManager (26, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test auto cache with devEngines.packageManager (26, macos-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with devEngines.packageManager (26, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with devEngines.packageManager (26, windows-latest) (push) Canceled after 0s
proxy / test-bypass-proxy (push) Canceled after 0s
versions / local-cache (22, macos-15-intel) (push) Canceled after 0s
versions / local-cache (22, macos-latest) (push) Canceled after 0s
e2e-cache / Test yarn 3 (Node 22, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test yarn 3 (Node 22, windows-latest) (push) Canceled after 0s
e2e-cache / Test yarn 3 (Node 24, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test yarn 3 (Node 24, ubuntu-latest) (push) Canceled after 0s
e2e-cache / Test yarn 3 (Node 24, windows-latest) (push) Canceled after 0s
e2e-cache / Test yarn 3 (Node 26, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test yarn 3 (Node 26, windows-latest) (push) Canceled after 0s
e2e-cache / Test yarn subprojects (22) (push) Canceled after 0s
e2e-cache / Test yarn subprojects (24) (push) Canceled after 0s
e2e-cache / Test yarn subprojects (26) (push) Canceled after 0s
e2e-cache / Test yarn subprojects all locally managed (22) (push) Canceled after 0s
e2e-cache / Test yarn subprojects some locally managed (24) (push) Canceled after 0s
e2e-cache / Test yarn subprojects some locally managed (26) (push) Canceled after 0s
e2e-cache / Test yarn subprojects managed by git (24) (push) Canceled after 0s
e2e-cache / Test yarn subprojects managed by git (26) (push) Canceled after 0s
e2e-cache / Test auto cache with top-level packageManager (22, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test auto cache with top-level packageManager (22, macos-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with top-level packageManager (22, windows-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with top-level packageManager (24, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test auto cache with top-level packageManager (24, macos-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with top-level packageManager (24, windows-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with top-level packageManager (26, macos-15-intel) (push) Canceled after 0s
e2e-cache / Test auto cache with top-level packageManager (26, macos-latest) (push) Canceled after 0s
e2e-cache / Test auto cache with top-level packageManager (26, ubuntu-latest) (push) Canceled after 0s
versions / nightly-syntax (24.0.0-nightly, ubuntu-latest) (push) Canceled after 0s
versions / nightly-syntax (24.0.0-nightly, windows-latest) (push) Canceled after 0s
versions / nightly-syntax (25-nightly, macos-15-intel) (push) Canceled after 0s
versions / local-cache (22, ubuntu-latest) (push) Canceled after 0s
versions / local-cache (22, windows-latest) (push) Canceled after 0s
versions / local-cache (24, macos-15-intel) (push) Canceled after 0s
versions / local-cache (24, macos-latest) (push) Canceled after 0s
versions / local-cache (24, ubuntu-latest) (push) Canceled after 0s
versions / local-cache (24, windows-latest) (push) Canceled after 0s
versions / local-cache (26, macos-15-intel) (push) Canceled after 0s
versions / local-cache (26, macos-latest) (push) Canceled after 0s
versions / local-cache (26, ubuntu-latest) (push) Canceled after 0s
versions / local-cache (26, windows-latest) (push) Canceled after 0s
versions / lts-syntax (lts/-1, macos-15-intel) (push) Canceled after 0s
versions / lts-syntax (lts/-1, ubuntu-latest) (push) Canceled after 0s
versions / lts-syntax (lts/-1, windows-latest) (push) Canceled after 0s
versions / lts-syntax (lts/*, macos-15-intel) (push) Canceled after 0s
versions / lts-syntax (lts/*, ubuntu-latest) (push) Canceled after 0s
versions / lts-syntax (lts/*, windows-latest) (push) Canceled after 0s
versions / v8-canary-syntax (26-v8-canary, macos-15-intel) (push) Canceled after 0s
versions / v8-canary-syntax (26-v8-canary, macos-latest) (push) Canceled after 0s
versions / v8-canary-syntax (26-v8-canary, ubuntu-latest) (push) Canceled after 0s
versions / v8-canary-syntax (26-v8-canary, windows-latest) (push) Canceled after 0s
versions / v8-canary-syntax (26.0.0-v8-canary20251016054584e5cf, macos-15-intel) (push) Canceled after 0s
versions / v8-canary-syntax (26.0.0-v8-canary20251016054584e5cf, macos-latest) (push) Canceled after 0s
versions / v8-canary-syntax (26.0.0-v8-canary20251016054584e5cf, ubuntu-latest) (push) Canceled after 0s
versions / v8-canary-syntax (26.0.0-v8-canary20251016054584e5cf, windows-latest) (push) Canceled after 0s
versions / v8-canary-syntax (26.0.0-v8-canary, macos-15-intel) (push) Canceled after 0s
versions / v8-canary-syntax (26.0.0-v8-canary, macos-latest) (push) Canceled after 0s
versions / v8-canary-syntax (26.0.0-v8-canary, ubuntu-latest) (push) Canceled after 0s
versions / v8-canary-syntax (26.0.0-v8-canary, windows-latest) (push) Canceled after 0s
versions / nightly-syntax (24.0.0-nightly, macos-15-intel) (push) Canceled after 0s
versions / nightly-syntax (24.0.0-nightly, macos-latest) (push) Canceled after 0s
versions / nightly-syntax (26-nightly, ubuntu-latest) (push) Canceled after 0s
versions / nightly-syntax (26-nightly, windows-latest) (push) Canceled after 0s
proxy / test-proxy (push) Canceled after 10s
versions / rc-syntax (24.0.0-rc.4, macos-15-intel) (push) Canceled after 0s
versions / nightly-syntax (25-nightly, macos-latest) (push) Canceled after 0s
versions / nightly-syntax (25-nightly, ubuntu-latest) (push) Canceled after 0s
versions / nightly-syntax (25-nightly, windows-latest) (push) Canceled after 0s
versions / nightly-syntax (26-nightly, macos-15-intel) (push) Canceled after 0s
versions / nightly-syntax (26-nightly, macos-latest) (push) Canceled after 0s
versions / rc-syntax (22.14.0-rc.1, macos-15-intel) (push) Canceled after 0s
versions / rc-syntax (22.14.0-rc.1, macos-latest) (push) Canceled after 0s
versions / rc-syntax (22.14.0-rc.1, ubuntu-latest) (push) Canceled after 0s
versions / rc-syntax (22.14.0-rc.1, windows-latest) (push) Canceled after 0s
versions / rc-syntax (24.0.0-rc.4, macos-latest) (push) Canceled after 0s
versions / rc-syntax (24.0.0-rc.4, ubuntu-latest) (push) Canceled after 0s
versions / rc-syntax (24.0.0-rc.4, windows-latest) (push) Canceled after 0s
versions / rc-syntax (26.0.0-rc.1, macos-15-intel) (push) Canceled after 0s
versions / rc-syntax (26.0.0-rc.1, macos-latest) (push) Canceled after 0s
versions / rc-syntax (26.0.0-rc.1, ubuntu-latest) (push) Canceled after 0s
versions / rc-syntax (26.0.0-rc.1, windows-latest) (push) Canceled after 0s
versions / manifest (22.0.0, macos-15-intel) (push) Canceled after 0s
versions / manifest (22.0.0, macos-latest) (push) Canceled after 0s
versions / manifest (22.0.0, ubuntu-latest) (push) Canceled after 0s
versions / manifest (22.0.0, windows-latest) (push) Canceled after 0s
versions / manifest (24.9.0, macos-15-intel) (push) Canceled after 0s
versions / manifest (24.9.0, macos-latest) (push) Canceled after 0s
versions / manifest (24.9.0, ubuntu-latest) (push) Canceled after 0s
versions / manifest (24.9.0, windows-latest) (push) Canceled after 0s
versions / manifest (26.5.0, macos-15-intel) (push) Canceled after 0s
versions / manifest (26.5.0, macos-latest) (push) Canceled after 0s
versions / manifest (26.5.0, ubuntu-latest) (push) Canceled after 0s
versions / manifest (26.5.0, windows-latest) (push) Canceled after 0s
versions / check-latest (22, macos-15-intel) (push) Canceled after 0s
versions / check-latest (22, macos-latest) (push) Canceled after 0s
versions / check-latest (22, ubuntu-latest) (push) Canceled after 0s
versions / check-latest (22, windows-latest) (push) Canceled after 0s
versions / check-latest (24, macos-15-intel) (push) Canceled after 0s
versions / check-latest (24, macos-latest) (push) Canceled after 0s
versions / check-latest (24, ubuntu-latest) (push) Canceled after 0s
versions / check-latest (24, windows-latest) (push) Canceled after 0s
versions / check-latest (26, macos-15-intel) (push) Canceled after 0s
versions / check-latest (26, macos-latest) (push) Canceled after 0s
versions / check-latest (26, ubuntu-latest) (push) Canceled after 0s
versions / check-latest (26, windows-latest) (push) Canceled after 0s
versions / version-file (.nvmrc, macos-15-intel) (push) Canceled after 0s
versions / version-file (.nvmrc, macos-latest) (push) Canceled after 0s
versions / version-file (.nvmrc, ubuntu-latest) (push) Canceled after 0s
versions / version-file (.nvmrc, windows-latest) (push) Canceled after 0s
versions / version-file (.tool-versions-node, macos-15-intel) (push) Canceled after 0s
versions / version-file (.tool-versions-node, macos-latest) (push) Canceled after 0s
versions / version-file (.tool-versions-node, ubuntu-latest) (push) Canceled after 0s
versions / version-file (.tool-versions-node, windows-latest) (push) Canceled after 0s
versions / version-file (.tool-versions, macos-15-intel) (push) Canceled after 0s
versions / version-file (.tool-versions, macos-latest) (push) Canceled after 0s
versions / version-file (.tool-versions, ubuntu-latest) (push) Canceled after 0s
versions / version-file (.tool-versions, windows-latest) (push) Canceled after 0s
versions / version-file (mise.toml, macos-15-intel) (push) Canceled after 0s
versions / version-file (mise.toml, macos-latest) (push) Canceled after 0s
versions / version-file (mise.toml, ubuntu-latest) (push) Canceled after 0s
versions / version-file (mise.toml, windows-latest) (push) Canceled after 0s
versions / version-file (package.json, macos-15-intel) (push) Canceled after 0s
versions / version-file (package.json, macos-latest) (push) Canceled after 0s
versions / version-file (package.json, ubuntu-latest) (push) Canceled after 0s
versions / version-file (package.json, windows-latest) (push) Canceled after 0s
versions / version-file-dev-engines (macos-latest) (push) Canceled after 0s
versions / version-file-dev-engines (ubuntu-latest) (push) Canceled after 0s
versions / version-file-dev-engines (windows-latest) (push) Canceled after 0s
versions / version-file-volta (macos-15-intel) (push) Canceled after 0s
versions / version-file-volta (macos-latest) (push) Canceled after 0s
versions / version-file-volta (ubuntu-latest) (push) Canceled after 0s
versions / version-file-volta (windows-latest) (push) Canceled after 0s
versions / version-file-volta-extends (macos-15-intel) (push) Canceled after 0s
versions / version-file-volta-extends (macos-latest) (push) Canceled after 0s
versions / version-file-volta-extends (ubuntu-latest) (push) Canceled after 0s
versions / version-file-volta-extends (windows-latest) (push) Canceled after 0s
versions / node-dist (21, macos-15-intel) (push) Canceled after 0s
versions / node-dist (21, macos-latest) (push) Canceled after 0s
versions / node-dist (21, ubuntu-latest) (push) Canceled after 0s
versions / node-dist (21, windows-latest) (push) Canceled after 0s
versions / node-dist (23, macos-15-intel) (push) Canceled after 0s
versions / node-dist (23, macos-latest) (push) Canceled after 0s
versions / node-dist (23, ubuntu-latest) (push) Canceled after 0s
versions / node-dist (23, windows-latest) (push) Canceled after 0s
versions / old-versions (macos-15-intel) (push) Canceled after 0s
versions / old-versions (ubuntu-latest) (push) Canceled after 0s
versions / old-versions (windows-latest) (push) Canceled after 0s
versions / arch (push) Canceled after 0s
versions / node-latest-aliases (current, macos-15-intel) (push) Canceled after 0s
versions / node-latest-aliases (current, macos-latest) (push) Canceled after 0s
versions / node-latest-aliases (current, ubuntu-latest) (push) Canceled after 0s
versions / node-latest-aliases (current, windows-latest) (push) Canceled after 0s
versions / node-latest-aliases (latest, macos-15-intel) (push) Canceled after 0s
versions / node-latest-aliases (latest, macos-latest) (push) Canceled after 0s
versions / node-latest-aliases (latest, ubuntu-latest) (push) Canceled after 0s
versions / node-latest-aliases (latest, windows-latest) (push) Canceled after 0s
versions / node-latest-aliases (node, macos-15-intel) (push) Canceled after 0s
versions / node-latest-aliases (node, macos-latest) (push) Canceled after 0s
versions / node-latest-aliases (node, ubuntu-latest) (push) Canceled after 0s
versions / node-latest-aliases (node, windows-latest) (push) Canceled after 0s
first commit
2026-10-30 14:20:31 +08:00

49 lines
2.0 KiB
Markdown

# 0. Support caching dependencies for mono repos
Date: 2021-07-13
Status: Proposed
## Context
Currently, `actions/setup-node` supports caching dependencies for Npm and Yarn package managers.
For the first iteration, we have decided to not support cases where `package-lock.json` / `yarn.lock` are located outside of repository root.
Current implementation searches the following file patterns in the repository root: `package-lock.json`, `yarn.lock` (in order of resolving priorities)
Obviously, it made built-in caching unusable for mono-repos and repos with complex structure.
We would like to revisit this decision and add customization for dependencies lock file location.
## Proposal
We have the following options:
1. Allow to specify directory where `package-lock.json` or `yarn.lock` are located
2. Allow to specify path to the dependencies lock file (including directory path and filename)
The second option looks more generic because it allows to:
- specify multiple dependencies files using file patterns like `**/package-lock.json` ([one of recommended approaches in actions/cache](https://github.com/actions/cache/blob/main/examples.md#macos-and-ubuntu))
- specify custom dependencies files like `src/npm-shrinkwrap.json`
- change default resolving priority if both `yarn.lock` and `package-lock.json` exist in repository
## Decision
Add `cache-dependency-path` input that will accept path (relative to repository root) to dependencies lock file.
If provided path contains wildcards, the action will search all matching files and calculate common hash like `${{ hashFiles('**/package-lock.json') }}` YAML construction does.
The hash of provided matched files will be used as a part of cache key.
Yaml examples:
```yml
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 14
cache: npm
cache-dependency-path: 'sub-project/package-lock.json'
```
```yml
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 14
cache: yarn
cache-dependency-path: 'sub-project/**/yarn.lock'
```