docs: add webhooksPath option for createNodeMiddleware (probot#1588)

  * the previously used version of ioredis was vulnerable to a prototype
    pollution attack: redis/ioredis#1267

docs/deployment.md

@@ -283,20 +283,19 @@ Please add yours!
 const { createNodeMiddleware, createProbot } = require("probot");
 
 const app = require("../../../app");
-const probot = createProbot({
-  defaults: {
-    webhookPath: "/api/github/webhooks",
-  },
-});
 
-module.exports = createNodeMiddleware(app, { probot });
+module.exports = createNodeMiddleware(app, {
+  probot: createProbot(),
+  webhooksPath: "/api/github/webhooks",
+});
 ```
 
 Examples
 
 - [probot/example-vercel](https://github.com/probot/example-vercel#readme)
 - [wip/app](https://github.com/wip/app#readme)
 - [all-contributors/app](https://github.com/all-contributors/app#readme)
+- [probot-nextjs-starter](https://github.com/maximousblk/probot-nextjs-starter#readme)
 
 Please add yours!
 

docs/development.md

@@ -224,6 +224,15 @@ const app = require("./index.js");
 module.exports = createNodeMiddleware(app, { probot: createProbot() });
 ```
 
+By default, `createNodeMiddleware()` uses `/` as the webhook endpoint. To customize this behaviour, you can use the `webhooksPath` option.
+
+```js
+module.exports = createNodeMiddleware(app, {
+  probot: createProbot(),
+  webhooksPath: "/path/to/webhook/endpoint",
+});
+```
+
 ### Use probot
 
 If you don't use Probot's http handling in order to receive and verify events from GitHub via webhook requests, you can use the [`Probot`](https://probot.github.io/api/latest/classes/probot.html) class directly.

package.json

@@ -47,7 +47,7 @@
     "@probot/octokit-plugin-config": "^1.0.0",
     "@probot/pino": "^2.2.0",
     "@types/express": "^4.17.9",
-    "@types/ioredis": "^4.17.8",
+    "@types/ioredis": "^4.27.1",
     "@types/pino": "^6.3.4",
     "@types/pino-http": "^5.0.6",
     "@types/update-notifier": "^5.0.0",
@@ -58,7 +58,7 @@
     "eventsource": "^1.0.7",
     "express": "^4.17.1",
     "hbs": "^4.1.1",
-    "ioredis": "^4.19.2",
+    "ioredis": "^4.27.8",
     "js-yaml": "^3.14.1",
     "lru-cache": "^6.0.0",
     "octokit-auth-probot": "^1.2.2",