Skip to content

Commit 34dc85c

Browse files
authored
Merge pull request #318 from dpiatek/add-yarn-readme-note
Add warning about auto-packing when using yarn
2 parents dc51648 + 292d595 commit 34dc85c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,12 @@ custom:
210210
```
211211
> Note that only relative path is supported at the moment.
212212

213+
#### Usage with yarn
214+
215+
Note that if auto-packing is enabled, the plugin will call `npm install`. If you are using yarn your `yarn.lock` file will be not be honored, which might lead to unexpected results as your dependencies will most likely not match (or be missing, as npm does not install packages in the same way as yarn).
216+
217+
Yarn support is planned [#286][link-286]. Until then we recommend using npm when using auto-packing.
218+
213219
#### Forced inclusion
214220

215221
Sometimes it might happen that you use dynamic requires in your code, i.e. you
@@ -666,3 +672,5 @@ plugin when running a command or invoked by a hook.
666672
[link-269]: https://github.com/serverless-heaven/serverless-webpack/issues/269
667673
668674
[link-263]: https://github.com/serverless-heaven/serverless-webpack/issues/263
675+
676+
[link-286]: https://github.com/serverless-heaven/serverless-webpack/issues/286

0 commit comments

Comments
 (0)