docs: keep README badges on latest release - #839
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the README’s Maven Central and Javadoc badge/link targets to use versionless “latest” URLs, preventing Release Please from accidentally desynchronizing badge images and link targets across releases.
Changes:
- Replace version-pinned Maven Central badge target with the versionless artifact URL.
- Replace version-pinned Javadoc badge and doc links with Javadoc.io’s versionless latest endpoints.
- Remove these links from Release Please’s version-managed sections and add an explanatory comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
6779c80 to
30c8221
Compare
HAYDEN-OAI
left a comment
There was a problem hiding this comment.
One substantive documentation correctness issue: the proposed Javadoc.io latest badge and link currently resolve to 4.45.0 even though Maven Central already serves 4.49.0. See the inline finding for the verified publication/indexing mismatch.
HAYDEN-OAI
left a comment
There was a problem hiding this comment.
Re-reviewed the updated head: the stale Javadoc links are removed, the Maven Central badge and target resolve to the latest published artifact, and all version-pinned installation snippets remain correctly managed by Release Please. Looks good.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (2)
README.md:4
- PR description says to switch to Javadoc.io's versionless latest-version badge/docs URLs, but the Javadoc badge was removed entirely. Consider restoring it with the versionless URLs so the badge image and link always point at the latest release.
<!-- This URL intentionally omits a version and stays outside Release Please markers so it tracks the latest release. -->
[](https://central.sonatype.com/artifact/com.openai/openai-java)
README.md:8
- The PR description also mentions updating the README's Javadoc link to a versionless latest-release URL, but the Javadoc reference was removed from this sentence. If the intent is to keep the link, point it at the versionless Javadoc.io doc URL so it stays in sync with the latest release.
The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs).
HAYDEN-OAI
left a comment
There was a problem hiding this comment.
Re-reviewed the complete five-commit history and final README-only diff at 0f11e4c. Confirmed the restored versionless Javadoc badge, Javadoc documentation, Maven Central badge, and Maven artifact page all agree on the latest actually published release (currently 4.49.0). The former Javadoc indexing lag has been repaired. Versionless links stay outside Release Please markers, while both installation-version sections remain correctly managed. No substantive correctness or maintainability issues found.
Summary
Why
Release Please's generic README updater changed the first version on the Javadoc badge line but left the link target on the previous release, as caught in the 4.50.0 release review. Using the providers' latest-version URLs removes the duplicated version state, so future release PRs cannot leave the badge image and target out of sync.
Impact
The README badges and Javadoc links now follow the latest published artifact without requiring per-release edits. Installation snippets remain version-pinned and managed by Release Please.
Validation
mise exec java@21 -- ./scripts/lintgit diff --check