Why run 'gradle clean build' instead of 'gradle build'?

GradleBuild System

Gradle Problem Overview


Why would I run gradle clean build instead of gradle build?

From what I understand, Gradle can detect source changes and update the final artifacts if needed. So why would I still need to clean?

Gradle Solutions


Solution 1 - Gradle

The clean task is defined by the java plugin and it simply removes the buildDir folder, thus cleaning everything including leftovers from previous builds which are no longer relevant. Not doing so may result in an unclean build which may be broken due to build artifacts produced by previous builds.

As an example assume that your build contains several tests that were failed and you decided that these are obsolete thus needs to be removed. Without cleaning the test results (using cleanTest task) or the build entirely (by running the clean task) you'll get stuck with the failed tests results which will cause your build to fail. Similar side effects can happen also with resources/classes removed from the sources but remained in the build folder that was not cleaned.

Solution 2 - Gradle

It removes the build directory. (Build contains the output of the gradle operation) gradle clean demo

Solution 3 - Gradle

You don't need to run the clean task. Gradle will track task dependencies and clean appropriate parts for you. Here's an example Gradle project I created to show that the accepted answer is incorrect.

If custom tasks don't track their dependencies well (they're bugged), then clean is a workaround.

Solution 4 - Gradle

Other build tools like buck will detect that some tests are removed and won't run them without the needs to run clean target. I think this is pitfall of gradle.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
Questionmarius bardanView Question on Stackoverflow
Solution 1 - GradleAmnon ShochotView Answer on Stackoverflow
Solution 2 - GradleSudip BhandariView Answer on Stackoverflow
Solution 3 - GradleDagguhView Answer on Stackoverflow
Solution 4 - GradleAdrian LiuView Answer on Stackoverflow