Skip to content

docs: fix multiversion build on old branches (javadoc errors) - #991

Merged
dkropachev merged 1 commit into
scylladb:scylla-4.xfrom
dgarcia360:docs-fix-javadoc
Aug 11, 2026
Merged

dkropachev merged 1 commit into
scylladb:scylla-4.xfrom
dgarcia360:docs-fix-javadoc

Conversation

@dgarcia360

@dgarcia360 dgarcia360 commented Aug 5, 2026 •

Copy link
Copy Markdown

Fixes docs publication workflow: https://github.com/scylladb/java-driver/actions/workflows/docs-pages.yml

Problem

The Docs / Publish workflow fails. sphinx-multiversion builds previous release branches (e.g. scylla-4.15.0.x) whose javadoc only passes doclint on JDK 8. Since the workflow moved to JDK 11, their builds error out (<table summary> not valid HTML5, unknown tag: leaks-private-api).

Solution

Set MAVEN_OPTS: -Dmaven.javadoc.failOnError=false on the "Build docs" step.

@coderabbitai

coderabbitai Bot commented Aug 5, 2026 •

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The documentation workflow sets MAVEN_OPTS with maven.javadoc.failOnError=false. Older release branches can continue documentation builds on JDK 11 despite Javadoc doclint errors.

Suggested reviewers: dkropachev

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly identifies the documentation multiversion build fix for Javadoc errors on old branches.
Description check ✅ Passed The description directly explains the workflow failure, its cause, and the Maven configuration change.

Comment @coderabbitai help to get the list of available commands.

@coderabbitai
coderabbitai Bot requested a review from dkropachev August 5, 2026 17:10
@dkropachev
dkropachev merged commit 3111d6e into scylladb:scylla-4.x Aug 11, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants