fix(java): the javadoc linked a method the binding does not have, and the v0.16.0 Java publish found it (#980) - #982
Merged
Conversation
`Pipeline#purpose`'s comment (#860) referred to `Disarm#listProfiles`. Python has `list_profiles`; the Java binding has `getPipeline(String)` and no listing at all. `javadoc` rejects a broken `{@link}`, and the only place the task ran was inside `publishAllPublicationsToStagingRepository`, so the v0.16.0 Java publisher failed at the Central Portal step with nothing uploaded, after every PR gate had passed and after the core, Node and Ruby artifacts had shipped. Reproduced locally with `./gradlew --offline :disarm-java:javadoc` (exit 1, "Pipeline.java:65: error: reference not found"); green after the change. The link now names `Disarm#getPipeline(String)`, which is what the sentence was about: a name goes in, and the step list says what the pipeline does, and neither says what it is for. CI's Java job runs `:disarm-java:javadoc` beside `check`, so the next broken reference fails its own pull request. `docs/java/api.md` lists `listLangs`, `listProfiles` and `reverseLangs` as Java entry points and none is declared; that is a parity gap rather than a link and is filed separately. Assisted-by: Claude Fable 5.1 Signed-off-by: Richard Quinn <quinn.richard@gmail.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The changes are small, well-scoped, and directly address a verified release-blocking Javadoc link failure while adding an appropriate CI gate to prevent recurrence.
Pull request overview
This PR fixes a broken Javadoc {@link} in the Java binding that caused the v0.16.0 Java publish to fail late in the release pipeline, and adds a CI gate so Javadoc link breakage fails on the introducing PR instead of during publishing.
Changes:
- Update
Pipeline#purposeJavadoc to link to an existing API (Disarm#getPipeline(String)) instead of a non-existentlistProfiles. - Run
:disarm-java:javadocin the CI Java job alongsidecheckto catch future broken Javadoc links earlier. - Document the fix and its impact in the Unreleased changelog.
File summaries
| File | Description |
|---|---|
| CHANGELOG.md | Adds an Unreleased “Fixed” entry describing the Javadoc-link publish failure and the CI gating change. |
| bindings/java/disarm-java/src/main/java/dev/disarm/Pipeline.java | Replaces broken {@link Disarm#listProfiles} with {@link Disarm#getPipeline(String)} in purpose() Javadoc. |
| .github/workflows/ci.yml | Extends the Java CI step to run ./gradlew ... :disarm-java:javadoc in addition to check. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Summary
The v0.16.0 Java publisher failed at the Central Portal step and uploaded nothing; the core, Node and Ruby artifacts shipped. The cause is a javadoc
{@link Disarm#listProfiles}onPipeline#purpose(#860): Python haslist_profiles, the Java binding has no listing at all,javadocrejects a broken link, and the only place the task ran was insidepublishAllPublicationsToStagingRepository.What changes
Pipeline.java:65linksDisarm#getPipeline(String)instead, which is what the sentence was about: a name goes in, the step list says what the pipeline does, and neither says what it is for.:disarm-java:javadocbesidecheck, so the next broken reference fails its own PR rather than the release after it.### Fixedentry under[Unreleased].Verification
./gradlew --offline :disarm-java:javadocon mainPipeline.java:65: error: reference not foundjavadoc, so the green here is the proofAfter merge
Dispatch
publish-java.ymlfrommain: the core 0.16.0 is on crates.io, sowait-for-coreresolves, andbuild.gradle.ktsonmaincarries 0.16.0, so the artifact version is right. Then confirmrepo1.maven.orgmetadata fordev.disarm:disarmanddisarm-kotlin, not the workflow.Not in this PR
docs/java/api.mdlistslistLangs,listProfilesandreverseLangsas Java entry points and none is declared. That is a parity gap rather than a link, filed as #981 with acceptance criteria.Refs #980, #981
🤖 Generated with Claude Code