This documentation is a preview of the pull request #2086

For the latest updates and improvements in production, open docs.codacy.com instead.

Running SpotBugs#

Enable SpotBugs and configure the corresponding code patterns on your repository Code patterns page.
Enable Run analysis on your build server on your repository Settings, tab General, Repository analysis on your server.

This setting enables Codacy to wait for the results of the local analysis before resuming the analysis of your commits.
Set up an API token to authenticate on Codacy:
- If you're setting up one repository, obtain a repository API token and set the following environment variable to specify your repository API token:
```
export CODACY_PROJECT_TOKEN=<your repository API token>
```
- If you're setting up multiple repositories, obtain an account API Token and set the following environment variable to specify the account API token:
```
export CODACY_API_TOKEN=<your account API token>
```
Warning

Never write API tokens to your configuration files and keep your API tokens well protected, as they grant owner permissions to your projects on Codacy.

It's a best practice to store API tokens as environment variables. Check the documentation of your CI/CD platform on how to do this.
If you're using Codacy Self-hosted set the following environment variable to specify your Codacy instance URL:
```
export CODACY_API_BASE_URL=<your Codacy instance URL>
```
Compile your Java or Scala repository on your build server, as you would normally do.

Download and run the Codacy Analysis CLI on the root of the repository, specifying the tool SpotBugs.

codacy-analysis-cli analyze --tool spotbugs \
                            --allow-network \
                            --upload \
                            --verbose

If you're using an account API token, you must also provide the flags --provider, --username, and --project. You can obtain the values for these flags from the URL of your repository dashboard on Codacy:

codacy-analysis-cli analyze --provider <gh, ghe, gl, gle, bb, or bbe> \
                            --username <name of your Codacy organization> \
                            --project <name of your repository> \
                            --tool spotbugs \
                            --allow-network \
                            --upload \
                            --verbose

The Codacy Analysis CLI runs SpotBugs on the compiled classes of your repository and uploads the results to Codacy so you can use them in your workflow.

Detecting sources and compiled classes#

The Codacy Analysis CLI tries to find the compiled classes and map results to the source files automatically. If you use Maven, Gradle, or sbt the Codacy Analysis CLI also detects the default layouts automatically.

If there is an issue with detection, you can configure these paths manually by adding a .codacy.yml Codacy configuration file to the root of the repository:

---
engines:
  spotbugs:
    modules:
      - classesDirectories: [ "core/target/classes" ]
        sourceDirectories:  [ "core/src/main" ]
      - classesDirectories: [ "api/target/classes" ]
        sourceDirectories:  [ "api/src/main" ]

Increasing the timeout to run SpotBugs#

When running SpotBugs on the compiled classes of larger projects, the default execution timeout of 15 minutes may not be enough for SpotBugs to complete the analysis.

To increase the timeout that SpotBugs has to execute, use the option --tool-timeout when running the Codacy Analysis CLI. For example, use --tool-timeout 1hour to set the timeout to one hour.

Advanced configuration#

See the available Codacy Analysis CLI configuration flags to configure running SpotBugs in more advanced scenarios.

Share your feedback 📢

Did this page help you?

Thanks for the feedback! Is there anything else you'd like to tell us about this page?

255 characters left

We're sorry to hear that. Please let us know what we can improve:

255 characters left

Alternatively, you can create a more detailed issue on our GitHub repository.

Thanks for helping improve the Codacy documentation.

Edit this page on GitHub if you notice something wrong or missing.

If you have a question or need help please contact support@codacy.com.

Last modified March 1, 2023