From 5aa72c249a47160b814e62b58a7d20910c1cec29 Mon Sep 17 00:00:00 2001 From: Maxim Lobanov Date: Tue, 13 Jul 2021 19:36:58 +0300 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Alena Sviridenko --- docs/adrs/0001-support-caching-deps-for-monorepos.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/adrs/0001-support-caching-deps-for-monorepos.md b/docs/adrs/0001-support-caching-deps-for-monorepos.md index 98167ec..c147864 100644 --- a/docs/adrs/0001-support-caching-deps-for-monorepos.md +++ b/docs/adrs/0001-support-caching-deps-for-monorepos.md @@ -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 @@ -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 @@ -45,4 +45,4 @@ steps: node-version: 14 cache: yarn deps-lock-file: 'sub-project/**/yarn.lock' -``` \ No newline at end of file +```