docs: update pluggable HTTP client guide to use OkHttpGitHubConnector#2266
Open
SAY-5 wants to merge 1 commit into
Open
docs: update pluggable HTTP client guide to use OkHttpGitHubConnector#2266SAY-5 wants to merge 1 commit into
SAY-5 wants to merge 1 commit into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2266 +/- ##
=========================================
Coverage 85.30% 85.30%
Complexity 2553 2553
=========================================
Files 241 241
Lines 7540 7540
Branches 396 396
=========================================
Hits 6432 6432
Misses 872 872
Partials 236 236 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
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.
Description
Fixes #2126.
The "Pluggable HTTP client" section of
src/site/apt/index.aptreferenced the legacyOkHttpConnectorplusOkUrlFactory.setCache()API, which no longer match the currentOkHttpGitHubConnector(inorg.kohsuke.github.extras.okhttp3). New users following this guide could not find a working integration path; the maintainer note on the issue confirms the desired direction (useOkHttpGitHubConnector+GitHubBuilder.withConnector()).The sample now:
GitHubConnector(the actual interface) instead ofHttpConnector,OkHttpGitHubConnectorand its package so it is greppable,OkHttpClientviaOkHttpClient.Builder().cache(...), matching the in-treeGitHubCachingTest.Before submitting a PR:
@linkJavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .mvn -D enable-ci clean install site "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED"locally. (Spotless verified locally.)main.When creating a PR: