Enable build cache support

[xvik]

Plugin version 4.0 lost gradle build cache support.

It was enabled in 3.0.0: https://github.com/spotbugs/spotbugs-gradle-plugin/blob/3.0.0/src/main/java/com/github/spotbugs/SpotBugsTask.java#L59

The fix is just to get back the @CacheableTask annotation on the SpotBugsTask.

Build cache can be verified as:

1. Run spotbugs task with build cache enabled:
   gradlew spotbugsMain --build-cache
   task status will be SUCCESS (task executed)
2. Do cleanup
   gradlew clean
3. Run the same task with enabled cache:
   gradlew spotbugsMain --build-cache
   task status should be FROM_CACHE (task output taken from the cache without execution)

[DPUkyle]

Please make sure this is well tested - simply slapping the @CacheableTask on a task does not make it "correct" in terms of inputs/outputs and relative path sensitivity.

I would like to help but it's a matter of finding time to do the work.

[DPUkyle]

A colleague and I are starting work to add a regression test to ensure the task is correctly cacheable.

[DPUkyle]

Note that in our testing we found the SpotBugsTask#projectName property has the ability to break cacheability.

Projects not setting rootProject.name = '...' in settings.gradle will inherit the name of the root folder as their projectName.

The workaround we took was to mark projectName as @Internal, not @Input. There are other approaches if the community does not find this acceptable.

[github-actions]

🎉 This issue has been resolved in version 4.2.1 🎉

The release is available on:

• 4.2.1
• GitHub release

Your semantic-release bot 📦🚀