Skip to content

Commit

Permalink
Merge pull request #318 from dpiatek/add-yarn-readme-note
Browse files Browse the repository at this point in the history
Add warning about auto-packing when using yarn
  • Loading branch information
HyperBrain authored Feb 6, 2018
2 parents dc51648 + 292d595 commit 34dc85c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,12 @@ custom:
```
> Note that only relative path is supported at the moment.

#### Usage with yarn

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).

Yarn support is planned [#286][link-286]. Until then we recommend using npm when using auto-packing.

#### Forced inclusion

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

0 comments on commit 34dc85c

Please sign in to comment.