Skip to content

Commit 31ce938

Browse files
KengoTODAhazendaz
authored andcommitted
docs: introduce how to use SpotBugs in the Android project
close #90
1 parent d7aee7b commit 31ce938

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This Gradle plugin is designed to solve the following problems in the legacy plu
1515
- [x] Remove any dependency on the Gradle's internal API
1616
- [x] Solve mutability problem for the build contains multiple projects and/or sourceSet
1717
- [x] Native Support for [the Parallel Build](https://guides.gradle.org/using-the-worker-api/)
18-
- [ ] Native Support for [the Android project](https://developer.android.com/studio/build/gradle-tips)
18+
- [x] Native Support for [the Android project](https://developer.android.com/studio/build/gradle-tips)
1919
- [x] Missing user document about how to use extension and task
2020

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

131131
### Apply to Android project
132132

133-
TBU
133+
Apply this plugin with the `com.android.application` plugin or `com.android.library` plugin to your project,
134+
then [`SpotBugsTask`](https://spotbugs-gradle-plugin.netlify.com/com/github/spotbugs/snom/spotbugstask) will be generated for each existing variant.
135+
136+
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.
134137

135138
### Configure the SpotBugsTask
136139

0 commit comments

Comments
 (0)