Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Alena Sviridenko <alenasviridenko@github.com>
  • Loading branch information
maxim-lobanov and AlenaSviridenko committed Jul 13, 2021
1 parent d9aab2a commit 5aa72c2
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/adrs/0001-support-caching-deps-for-monorepos.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Currently, `actions/setup-node` supports caching dependencies for Npm and Yarn p
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)

Obviosly, it made build-in caching unusable for mono-repos and repos with complex structure.
Obviously, it made build-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
Expand All @@ -24,8 +24,8 @@ The second option looks more generic because it allows to:
## Decision

Add `deps-lock-file` input that will accept path (relative to repository root) to dependencies lock file.
If path provided path contains wildcards, the action will search all maching files and calculate common hash like `${{ hashFiles('**/packages.lock.json') }}` YAML construction does.
The hash of privided matched files will be used as a part of cache key.
If provided path contains wildcards, the action will search all maching files and calculate common hash like `${{ hashFiles('**/packages.lock.json') }}` YAML construction does.
The hash of provided matched files will be used as a part of cache key.

Yaml examples:
```yml
Expand All @@ -45,4 +45,4 @@ steps:
node-version: 14
cache: yarn
deps-lock-file: 'sub-project/**/yarn.lock'
```
```

0 comments on commit 5aa72c2

Please sign in to comment.