Add instructions on how to use with serverless-offline #104
Conversation
Adding a brief instructional section on how to use this plugin with serverless-offilne. I had to dig around a while to discover that you need the --location flag.
There was a problem hiding this comment.
Looked over this again ... the second alternative offline invocation should be mentioned too, although I do not really know, when exactly which one is needed. We use it without start here.
#131 Adds support for the start command (additional hook).
|
|
||
| - Let serverless-offline know where the bundles are built | ||
| ``` | ||
| > serverless offline start --location .webpack |
There was a problem hiding this comment.
This command line will work as soon as #131 is merged.
The alternative is omitting start, so we may add the serverless command without start here too:
serverless offline --location .webpack
There was a problem hiding this comment.
Good catch, @HyperBrain!
|
@hassankhan Just merged #132 which also updates the serverless offline section. We should compare the two and see how they fit together. |
|
Should we perhaps add a note mentioning if you use custom paths for your |
| @@ -118,6 +118,21 @@ The normal Serverless deploy procedure will automatically bundle with Webpack: | |||
| - Install Serverless Webpack as above | |||
| - Deploy with `serverless deploy` | |||
|
|
|||
| ### Use with serverless-offline | |||
There was a problem hiding this comment.
Perhaps change to 'Usage'?
There was a problem hiding this comment.
I will change it accordingly and also add the --location hint (as long as I'm allowed to do that). Otherwise I open a separate PR with the same changes (as they are trivial) and close this one to get 2.0.0 out later.
There was a problem hiding this comment.
@hassankhan Just saw, that we have 2 sections for serverless-offline. This one and one under "Simulate API Gateway locally". I will combine the two into this one (as we plan to remove serve) and commit that. Then we can just remove the whole "Simulate ..." section together with the serve implementation later.
|
Restructured serverless-offline doc in #144 and integrated everything discussed or changed here. So this one is obsoleted and can be closed. |
Adding a brief instructional section on how to use this plugin with serverless-offilne. I had to dig around a while to discover that you need the --location flag.