docs: update README Maven version guidance#9426
Draft
Bojun-Vvibe wants to merge 1 commit intosquare:masterfrom
Draft
docs: update README Maven version guidance#9426Bojun-Vvibe wants to merge 1 commit intosquare:masterfrom
Bojun-Vvibe wants to merge 1 commit intosquare:masterfrom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Repo: square/okhttp (⭐ 46000)
Type: docs
Files changed: 1
Lines: +1/-3
What
Updated the README's Maven setup example so it matches the release version advertised elsewhere in the document. The change bumps the
okhttp-bomexample from5.2.0to5.3.0and removes the obsolete explicitokhttp-jvmversion override from the sample dependency block.Why
The README previously mixed current and stale Maven guidance in the same section, which could lead users to copy an outdated BOM version or unnecessarily pin
okhttp-jvmto5.1.0. The repository's ownmaven-tests/pom.xmlshows the BOM is intended to supply that version, so the override is no longer appropriate in user-facing documentation.Testing
Verified the README diff locally and confirmed there are no remaining stale
5.2.0/5.1.0references in the updated Maven snippet. No code or test execution was needed because this is a documentation-only change.Risk
Low + documentation-only change that aligns examples with the current release and existing Maven usage in the repo.