fix(types): remove pagination support for GHEC routes #464
Conversation
This file contains 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
octokitbot
added
the
Type: Maintenance
gr2m
changed the title
gr2m
changed the title
gr2m
approved these changes
Oct 13, 2022
There was a problem hiding this comment.
so the @octokit/plugin-paginate-rest plugin actually supports GHEC routes up until now.
Technically we will have a breaking change, but it's types only, it does not affect code in production, as pagination works by checking response headers and body
I would recommend to elease a breaking version of @octokit/plugin-paginate-rest anyway, but then bump the version of this plugin in octokit and @octokit/rest in a fix release only. That will prevent some of the cryptic TypeScript errors that folks have seen in the past, where they needed to nuke the node_modules folder and their lock file to resolve.
kfcampbell
approved these changes
Oct 13, 2022
|
🎉 This PR is included in version 5.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
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.
BREAKING CHANGE: Type support for GHEC routes has been removed. There are no code changes.