Skip to content

docs: introduce how to use SpotBugs in the Android project #281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KengoTODA wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: introduce how to use SpotBugs in the Android project #281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This Gradle plugin is designed to solve the following problems in the legacy plu
- [x] Remove any dependency on the Gradle's internal API
- [x] Solve mutability problem for the build contains multiple projects and/or sourceSet
- [x] Native Support for [the Parallel Build](https://guides.gradle.org/using-the-worker-api/)
- [ ] Native Support for [the Android project](https://developer.android.com/studio/build/gradle-tips)
- [x] Native Support for [the Android project](https://developer.android.com/studio/build/gradle-tips)
- [x] Missing user document about how to use extension and task

## Usage
Expand Down Expand Up @@ -130,7 +130,10 @@ If you want to create and configure `SpotBugsTask` by own, apply the base plugin

### Apply to Android project

TBU
Apply this plugin with the `com.android.application` plugin or `com.android.library` plugin to your project,
then [`SpotBugsTask`](https://spotbugs-gradle-plugin.netlify.com/com/github/spotbugs/snom/spotbugstask) will be generated for each existing variant.
Copy link
Copy Markdown
Contributor

@davidburstromspotify davidburstromspotify Jun 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd just like to point out that the tasks are only created for the production code variants on the Android projects. In Java projects, both production and test source sets gets corresponding tasks. It's relatively easy to do the same thing for Android projects.

Copy link
Copy Markdown
Member Author

@KengoTODA KengoTODA Jun 7, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be better to do it 👍, could you suggest the change making it possible?

I guess we need to use TestExtension, AppExtension#testVariants or AppExtension#unitTestVariants but not so sure.

Copy link

Copilot AI Jan 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The URL for SpotBugsTask documentation has two issues:

  1. The base URL uses spotbugs-gradle-plugin.netlify.com while other SpotBugsTask references in the file (lines 127 and 140) use spotbugs.github.io/spotbugs-gradle-plugin/spotbugs-gradle-plugin
  2. The path uses spotbugstask (all lowercase) while line 127 uses -spot-bugs-task (with proper kebab-case)

For consistency with the rest of the README, this should match the URL format used in line 127.

Copilot uses AI. Check for mistakes.

If you want to create and configure `SpotBugsTask` by own, apply the base plugin (`com.github.spotbugs-base`) instead, then it won't create tasks automatically.

### Configure the SpotBugsTask

Expand Down
Loading