Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: v9 #533

Merged
merged 13 commits into from
Apr 14, 2021
Merged

feat: v9 #533

merged 13 commits into from
Apr 14, 2021

Conversation

gr2m
Copy link
Contributor

@gr2m gr2m commented Apr 14, 2021

closes #518
fixes #477, fixes #515, fixes #476, fixes #475

Breaking changes

  • default sign algorithm for webhooks.sign is now sha256. Use webhooks.sign({ algorithm: "sha1", secret }, payload) to fall back to sha1.
  • static sign and verify methods are no longer exported. Use @octokit/webhooks-methods package instead
  • webhooks.sign() and webhooks.verify() are now asynchronous

View rendered README.md
View rendered src/middleware-legacy/README.md
View rendered src/sign/README.md
View rendered src/verify/README.md

gr2m added 10 commits April 14, 2021 00:59
BREAKING CHANGE: `createWebhooksApi()` has been removed. Use `new Webhooks()` instead
…Middleware`

BREAKING CHANGE: `webhooks.middleware` has been removed. Use `createNodeMiddleware()` instead

BREAKING CHANGE: `createMiddleware` has been removed. Use `createNodeMiddleware()` instead
BREAKING CHANGE: deprecated `path` option for `Webhooks` constructor has been removed. Use `createNodeMiddleware(webhooks, { path })` instead
BREAKING CHANGE: all usage of [`debug`](https://www.npmjs.com/package/debug) has been removed. Use the `log` option instead
BREAKING CHANGE: `sign` and `webhooks.sign` no default to `sha256` algorithm. In order to continue to use `sha1`, replace

```js
sign(secret, payload)
```

with

```js
sign({ secret, algorith: "sha1" }, payload)
```
BREAKING CHANGE: `webhooks.sign()` and `webhooks.verify()` are now asynchronous

BREAKING CHANGE: static `sign` and `verify` methods are no longer exported. Use `@octokit/webhooks-methods` package instead
@gr2m gr2m added the Type: Feature New feature or request label Apr 14, 2021
@gr2m gr2m merged commit 024e3ee into master Apr 14, 2021
@gr2m gr2m deleted the beta-rebased branch April 14, 2021 08:18
@github-actions
Copy link
Contributor

🎉 This PR is included in version 9.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Feature New feature or request
Projects
None yet
1 participant