fix: update ref to deprecated package #2089
Open
+3
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Hi! `@octokit/webhooks-definitions` -> `@octokit/webhooks-types`
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README to replace the deprecated @octokit/webhooks-definitions package with the new @octokit/webhooks-types.
- Swapped out package name in documentation text.
- Updated
npm installcommand to use the new package. - Changed the TypeScript import path for
PushEvent.
Comments suppressed due to low confidence (1)
packages/github/README.md:62
- [nitpick] The phrase 'response payloads' might be misleading here; consider using 'webhook event payloads' for clarity.
The npm module `@octokit/webhooks-types` provides type definitions for the response payloads. You can cast the payload to these types for better type information.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi!
@octokit/webhooks-definitions->@octokit/webhooks-types