Repository navigation
Skip javadoc generation in integration test workflows - #4657
Merged
Merged
Conversation
Javadoc jars were built on every integration test run: integration.yml had an explicit "Build docs" step, and the javadoc:jar execution bound to the package phase ran during every "mvn clean verify" in both integration.yml (via make test-local) and the run-tests composite action used by test-on-docker.yml. Skip it in these workflows to speed up CI; javadoc build breakage is still caught by unit-tests.yml. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
Javadoc jars were being built on every integration test run, adding avoidable time to CI:
integration.ymlhad an explicit "Build docs" step runningmvn javadoc:jar.attach-javadocexecution inpom.xmlis bound to thepackagephase, so everymvn clean verifyalso rebuilt the javadoc jar — both inintegration.yml(viamake test-local) and in therun-testscomposite action used by every matrix job oftest-on-docker.yml.Changes
.github/workflows/integration.yml— removed the "Build docs" step and setMAVEN_OPTS: -Dmaven.javadoc.skip=trueon the test step (the property has to come in via the environment becausemvnis invoked throughmake)..github/actions/run-tests/action.yml— added-Dmaven.javadoc.skip=trueto bothmvn clean verifyinvocations, covering alltest-on-docker.ymlmatrix jobs.No changes needed elsewhere:
spring-data-redis-integration.ymlalready skips javadoc,doctests.yml/benchmarks.ymlstop at thetestphase, andunit-tests.ymlintentionally keepsmvn javadoc:jarso javadoc build breakage is still caught in CI — once, in the cheap workflow, instead of in every integration job.🤖 Generated with Claude Code
Note
Low Risk
CI-only workflow tuning with no application or runtime behavior changes; Javadoc validation remains in unit-tests.yml.
Overview
Speeds up integration CI by not building Javadoc on every integration run. Javadoc is still built in
unit-tests.yml, so doc breakage stays covered once in the cheaper workflow.In
integration.yml, the dedicated Build docs step (mvn javadoc:jar) is removed, and the test step setsMAVEN_OPTS: -Dmaven.javadoc.skip=truesomake test-localskips Javadoc duringverify/package.In
run-tests(used by Docker matrix jobs), both Maven invocations add-Dmaven.javadoc.skip=true, with comments noting validation happens in unit tests.Reviewed by Cursor Bugbot for commit 1dda90c. Bugbot is set up for automated code reviews on this repo. Configure here.