Deprecate getNodeMiddleware in favor of createNodeMiddleware
gr2m opened this issue · 1 comments
What’s missing?
import { createNodeMiddleware } from "@octokit/app"Why?
We currently have an inconsistent naming for a method that exports a http middleware that is compatible with Node's built in http server as well as express. @octokit/app currently exports getNodeMiddleware, but in other modules and in @probot we use the name createNodeMiddleware.
How
Start by creating /test/deprecations.test.ts, similar to probot's deprecation tests in v10. The test should import getNodeMiddleware and use it, then verify that a deprecation message was logged.
You can start a pull request draft at this point.
Then update the existing tests to import createNodeMiddleware instead of getNodeMiddleware.
Finally implement the deprecation log when calling getNodeMiddleware and the new createNodeMiddleware export
🎉 This issue has been resolved in version 10.3.0 🎉
The release is available on:
Your semantic-release bot 📦🚀