Update deploy with aws serverless guide #1066
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1066 +/- ##
=======================================
Coverage 68.89% 68.89%
=======================================
Files 13 13
Lines 1212 1212
Branches 357 357
=======================================
Hits 835 835
Misses 304 304
Partials 73 73 Continue to review full report at Codecov.
|
| @@ -108,15 +108,26 @@ Now that you have an app, let's prepare it for AWS Lambda and the Serverless Fra | |||
|
|
|||
| **1. Prepare the app for AWS Lambda** | |||
|
|
|||
| By default, Bolt listens for HTTP requests. In this section, we'll customize your Bolt app's [`receiver`](https://slack.dev/bolt-js/concepts#receiver) to respond to Lambda function events instead. | |||
| By default, our Bolt Getting Started app sample is configured to use SocketMode. Let's update the setup in `app.js` to have our app listen for HTTP requests instead. | |||
docs/_deployments/aws-lambda.md
Outdated
|
|
||
| ```javascript | ||
| const { App, AwsLambdaReceiver } = require('@slack/bolt'); | ||
| ``` | ||
|
|
||
| Then update the [source code that initializes your Bolt app](https://github.com/slackapi/bolt-js-getting-started-app/blob/main/app.js#L3-L7) to create a custom receiver using AwsLambdaReceiver: | ||
| Then update the [source code that initializes your Bolt app](https://github.com/slackapi/bolt-js-getting-started-app/blob/main/app.js#L10-L14) to create a custom receiver using AwsLambdaReceiver: |
There was a problem hiding this comment.
This may not be a change that we want to have this time (as the existing one had the same room for improvement) but let me share a minor suggestion.
L10-14 in the main branch can be different in the future. If we point specific lines, we can use a specific revision for it (and we may want to update the revision if it becomes very old after a while). https://github.com/slackapi/bolt-js-getting-started-app/blob/4c29a21438b40f0cbca71ece0d39b356dfcf88d5/app.js#L10-L14
There was a problem hiding this comment.
Ah interesting. Linking the revision keeps the link from breaking due to direct changes. I like that! I've updated both links based on that feedback. 🙇
|
Thanks for updating this PR! Looks great to me. This pull request fixes #1062 as well |
Summary
Tweaks AWS Serverless deployment guide to include instructions for disabling SocketMode (from Getting Started App sample). Now that SocketMode is default in the Getting Started guide, devs who want to set up their app as Serverless Lambda function need to turn off SocketMode in favor of HTTP.
Also fixes #1062 by adding a warning.
Requirements (place an
xin each[ ])