chore: Merge latest master into beta (#1915)

Co-authored-by: Aaron Dewes <aaron.dewes@protonmail.com> Co-authored-by: Sangwon Kim <hello@kdby.io> Co-authored-by: scon.io <iam@scon.io> Co-authored-by: David Brodski <129956+kammerjaeger@users.noreply.github.com> Co-authored-by: Gregor Martynus <39992+gr2m@users.noreply.github.com>
probot · Nov 15, 2023 · 97cc1bc · 97cc1bc
1 parent 8dc41a9
commit 97cc1bc
Show file tree

Hide file tree

Showing 18 changed files with 72 additions and 90 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,5 @@
 ---
-next: docs/hello-world.md
+next: hello-world
 title: Introduction
 layout: docs.liquid
 ---

diff --git a/docs/best-practices.md b/docs/best-practices.md
@@ -43,8 +43,8 @@ The [uncanny valley](https://en.wikipedia.org/wiki/Uncanny_valley) is the hypoth
 
 Your app should be empathetic, but it shouldn't pretend to be human. It is an app and everyone that interacts with it knows that.
 
-> - :smile: "Latest build failures: _{listing of build failures}_…"
-> - :cry: "Hey there! You asked for the build failures, so I went and dug them up for you: _{listing of build failures}_ … Have a fantastic day!"
+> - 😄 "Latest build failures: _{listing of build failures}_…"
+> - 😢 "Hey there! You asked for the build failures, so I went and dug them up for you: _{listing of build failures}_ … Have a fantastic day!"
 
 ## Autonomy
 

diff --git a/docs/configuration.md b/docs/configuration.md
diff --git a/docs/deployment.md b/docs/deployment.md
@@ -1,5 +1,5 @@
 ---
-next: docs/http.md
+next: http
 title: Deployment
 ---
 
@@ -123,7 +123,7 @@ Probot runs like [any other Node app](https://devcenter.heroku.com/articles/depl
 
 ### As serverless function
 
-When deploying your Probot app to a serverless/function environment, you don't need to worry about handling the http webhook requests coming from GitHub, the platform takes care of that. In many cases you can use [`createNodeMiddleware`](/docs/development.md#use-createNodeMiddleware) directly, e.g. for Vercel or Google Cloud Function.
+When deploying your Probot app to a serverless/function environment, you don't need to worry about handling the http webhook requests coming from GitHub, the platform takes care of that. In many cases you can use [`createNodeMiddleware`](/docs/development/#use-createNodeMiddleware) directly, e.g. for Vercel or Google Cloud Function.
 
 ```js
 const { Probot, createProbot } = require("probot");

diff --git a/docs/development.md b/docs/development.md
@@ -1,5 +1,5 @@
 ---
-next: docs/webhooks.md
+next: webhooks
 title: Developing an app
 ---
 
@@ -259,7 +259,7 @@ async function example() {
 }
 ```
 
-Using the `Probot` class directly is great for [writing tests](/docs/testing.md) for your Probot app function. It permits you to pass a custom logger to test for log output, disable throttling, request retries, and much more.
+Using the `Probot` class directly is great for [writing tests](/docs/testing) for your Probot app function. It permits you to pass a custom logger to test for log output, disable throttling, request retries, and much more.
 
 ### Use Probot's Octokit
 

diff --git a/docs/extensions.md b/docs/extensions.md
@@ -1,5 +1,5 @@
 ---
-next: docs/persistence.md
+next: persistence
 title: Extensions
 ---
 

diff --git a/docs/github-api.md b/docs/github-api.md
@@ -1,5 +1,5 @@
 ---
-next: docs/configuration.md
+next: configuration
 title: Interacting with GitHub
 ---
 
@@ -86,7 +86,7 @@ Check out the [GitHub GraphQL API docs](https://docs.github.com/en/graphql) to l
 
 ## Unauthenticated Events
 
-When [receiving webhook events](/docs/webhooks.md), `context.octokit` is _usually_ an authenticated client, but there are a few events that are exceptions:
+When [receiving webhook events](/docs/webhooks), `context.octokit` is _usually_ an authenticated client, but there are a few events that are exceptions:
 
 - [`installation.deleted` & `installation.suspend`](https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#installation) - The installation was _just_ deleted or suspended, so we can't authenticate as the installation.
 
@@ -102,7 +102,7 @@ If you want to run a Probot App against a GitHub Enterprise instance, you'll nee
 GHE_HOST=fake.github-enterprise.com
 ```
 
-When [using Probot programmatically](/docs/development.md#run-probot-programmatically), set the `baseUrl` option for the [`Probot`](https://probot.github.io/api/latest/classes/probot.Probot.html) constructor to the full base Url of the REST API
+When [using Probot programmatically](/docs/development/#run-probot-programmatically), set the `baseUrl` option for the [`Probot`](https://probot.github.io/api/latest/classes/probot.Probot.html) constructor to the full base Url of the REST API
 
 ```js
 const MyProbot = Probot.defaults({

diff --git a/docs/hello-world.md b/docs/hello-world.md
@@ -1,5 +1,5 @@
 ---
-next: docs/development.md
+next: development
 title: Hello World
 ---
 
@@ -26,7 +26,7 @@ module.exports = (app) => {
 };
 ```
 
-The [`context`](https://probot.github.io/api/latest/classes/context.Context.html) passed to the event handler includes everything about the event that was triggered, as well as some helpful properties for doing something useful in response to the event. `context.octokit` is an authenticated GitHub client that can be used to [make REST API and GraphQL calls](/docs/github-api.md), and allows you to do almost anything programmatically that you can do through a web browser on GitHub.
+The [`context`](https://probot.github.io/api/latest/classes/context.Context.html) passed to the event handler includes everything about the event that was triggered, as well as some helpful properties for doing something useful in response to the event. `context.octokit` is an authenticated GitHub client that can be used to [make REST API and GraphQL calls](/docs/github-api), and allows you to do almost anything programmatically that you can do through a web browser on GitHub.
 
 Here is an example of an autoresponder app that comments on opened issues:
 

diff --git a/docs/http.md b/docs/http.md
@@ -1,11 +1,11 @@
 ---
-next: docs/pagination.md
+next: pagination
 title: HTTP routes
 ---
 
 # HTTP routes
 
-When starting your app using `probot run ./app.js` or using the [`Server`](/docs/development.md#use-server) class, your Probot app function will receive the `options.getRouter` function as its 2nd argument.
+When starting your app using `probot run ./app.js` or using the [`Server`](/docs/development/#use-server) class, your Probot app function will receive the `options.getRouter` function as its 2nd argument.
 
 Calling `getRouter('/my-app')` will return an [express](http://expressjs.com/) router that you can use to expose custom HTTP endpoints from your app.
 

diff --git a/docs/logging.md b/docs/logging.md
@@ -1,5 +1,5 @@
 ---
-next: docs/deployment.md
+next: deployment
 title: Logging
 ---
 

diff --git a/docs/pagination.md b/docs/pagination.md
@@ -1,5 +1,5 @@
 ---
-next: docs/extensions.md
+next: extensions
 title: Pagination
 ---
 

diff --git a/docs/persistence.md b/docs/persistence.md
@@ -1,5 +1,5 @@
 ---
-next: docs/best-practices.md
+next: best-practices
 title: Persistence
 ---
 

diff --git a/docs/simulating-webhooks.md b/docs/simulating-webhooks.md
@@ -1,5 +1,5 @@
 ---
-next: docs/logging.md
+next: logging
 title: Simulate receiving webhooks
 ---
 

diff --git a/docs/testing.md b/docs/testing.md
@@ -1,5 +1,5 @@
 ---
-next: docs/simulating-webhooks.md
+next: simulating-webhooks
 title: Testing
 ---
 

diff --git a/docs/webhooks.md b/docs/webhooks.md
@@ -1,5 +1,5 @@
 ---
-next: docs/github-api.md
+next: github-api
 title: Receiving webhooks
 ---
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -38,13 +38,13 @@
   "dependencies": {
     "@octokit/core": "^5.0.1",
     "@octokit/plugin-enterprise-compatibility": "^4.0.1",
-    "@octokit/plugin-paginate-rest": "^9.1.3",
-    "@octokit/plugin-rest-endpoint-methods": "^10.1.3",
+    "@octokit/plugin-paginate-rest": "^9.1.4",
+    "@octokit/plugin-rest-endpoint-methods": "^10.1.5",
     "@octokit/plugin-retry": "^6.0.1",
     "@octokit/plugin-throttling": "^8.1.2",
-    "@octokit/types": "^12.2.0",
-    "@octokit/webhooks": "^12.0.3",
-    "@probot/get-private-key": "^1.1.1",
+    "@octokit/types": "^12.3.0",
+    "@octokit/webhooks": "^12.0.4",
+    "@probot/get-private-key": "^1.1.2",
     "@probot/octokit-plugin-config": "^2.0.1",
     "@probot/pino": "^2.3.5",
     "@types/express": "^4.17.21",

diff --git a/src/types.ts b/src/types.ts
@@ -61,7 +61,7 @@ export type ApplicationFunctionOptions = {
 export type ApplicationFunction = (
   app: Probot,
   options: ApplicationFunctionOptions,
-) => void;
+) => void | Promise<void>;
 
 export type ServerOptions = {
   cwd?: string;