Skip to content

v3.0.0

Choose a tag to compare

@github-actions github-actions released this 23 Mar 17:11
9f0472e

Apologies for the breaking changes without previous deprecations. We had to compromise due to lack of time.

BREAKING CHANGES

  • stateless methods have been removed. Use @octokit/oauth-methods instead
  • You must now set clientType to "github-app" for usage with GitHub Apps
  • getNodeMiddleware() export has been removed. Use createNodeMiddleware() instead
  • const { token, scopes } = app.createToken(options) is now const { authentication: { token, scopes } } = app.createToken(options)
  • const url = app.getAuthorizationUrl() is now const { url } = app.getWebFlowAuthorizationUrl();
  • before_delete action removed for token and authorization events. We could add them back, but it would require an additional request, we'd like to see if there are people why actually use these events.

Features

  • app.getUserOctokit()
  • app.refreshToken()
  • app.scopeToken()
  • app.createToken() now supports the device flow
  • TypeScript: different types depending on clientType constructor option (OAuth App or GitHub App) (#204) (9f0472e)