Repository files navigation

SpotBugs is the spiritual successor ofFindBugs, carrying on from the point where it left off with support of its community.

SpotBugs is licensed under theGNU LESSER GENERAL PUBLIC LICENSE.

More information at theofficial website. A lot of things can still be found at theold FindBugs website.

SpotBugs is built usingGradle. The recommended way to obtain it is to simply run thegradlew (orgradlew.bat) wrapper, which will automatically download and run the correct version as needed (using the settings ingradle/wrapper/gradle-wrapper.properties).

Building SpotBugs requires JDK 21 to run all the tests (using SpotBugs requires JDK 11 or above, but it can analyze code compiled with older versions).

To see a list of build options, rungradle tasks (orgradlew tasks). Thebuild task will perform a full build and test.

To build the SpotBugs plugin for Eclipse, you'll need to create the fileeclipsePlugin/local.properties, containing a propertyeclipseRoot.dir that points to an Eclipse installation's root directory (see.github/workflows/release.yml for an example), then run the build.To prepare Eclipse environment only, run./gradlew eclipse. See alsodetailed steps.

SpotBugs can be used standalone and through several integrations, including:

• Ant
• Maven
• Gradle
• Eclipse
• Sonarqube
• IntelliJ IDEA

You can contact us usingGitHub Discussions.