Skip to content

Commit 25c09bd

Browse files
committed
update docs
1 parent d97edbf commit 25c09bd

File tree

3 files changed

+58
-3
lines changed

3 files changed

+58
-3
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1+
### 1.1.0 (2015-12-21)
2+
13
* Add [ru.vyarus.animalsniffer](https://github.com/xvik/gradle-animalsniffer-plugin) plugin configuration support
4+
* Improve FindBugs console output
25

36
### 1.0.3 (2015-12-11)
47

README.md

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ buildscript {
3030
jcenter()
3131
}
3232
dependencies {
33-
classpath 'ru.vyarus:gradle-quality-plugin:1.0.3'
33+
classpath 'ru.vyarus:gradle-quality-plugin:1.1.0'
3434
}
3535
}
3636
apply plugin: 'ru.vyarus.quality'
@@ -40,7 +40,7 @@ OR
4040

4141
```groovy
4242
plugins {
43-
id 'ru.vyarus.quality' version '1.0.3'
43+
id 'ru.vyarus.quality' version '1.1.0'
4444
}
4545
```
4646

@@ -164,6 +164,44 @@ Or you can use annotations. FindBugs use custom annotations and so you need to a
164164
@SuppressFBWarnings("URF_UNREAD_FIELD")
165165
```
166166

167+
###### Plugins
168+
169+
You may add additional findbugs checks by declaring findbugs plugins in `findbugsPlugins` dependency configuration.
170+
But, as findbugs plugin applied after configuration read, there are two options:
171+
172+
Either use afterEvaluate:
173+
174+
```groovy
175+
afterEvaluate {
176+
dependencies {
177+
findbugsPlugins 'com.mebigfatguy.fb-contrib:fb-contrib:6.4.1'
178+
}
179+
}
180+
```
181+
182+
Or declare findbugs plugin manually (it will be configured by quality plugin):
183+
184+
```groovy
185+
plugins {
186+
id 'findbugs'
187+
}
188+
dependencies {
189+
findbugsPlugins 'com.mebigfatguy.fb-contrib:fb-contrib:6.4.1'
190+
}
191+
```
192+
193+
[Find Security Bugs](http://find-sec-bugs.github.io/)
194+
195+
```groovy
196+
findbugsPlugins 'com.h3xstream.findsecbugs:findsecbugs-plugin:1.4.4'
197+
```
198+
199+
[fb-contrib: A FindBugs auxiliary detector plugin](http://fb-contrib.sourceforge.net/)
200+
201+
```groovy
202+
findbugsPlugins 'com.mebigfatguy.fb-contrib:fb-contrib:6.4.1'
203+
```
204+
167205
###### Annotations
168206

169207
You may use [jsr305 annotations](http://findbugs.sourceforge.net/manual/annotations.html) to guide findbugs.
@@ -205,6 +243,19 @@ To [suppress violation](http://codenarc.sourceforge.net/codenarc-configuring-rul
205243
@SuppressWarnings("ClassJavadoc")
206244
```
207245

246+
#### AnimalSniffer
247+
248+
If [ru.vyarus.animalsniffer](https://github.com/xvik/gradle-animalsniffer-plugin) applied then
249+
it will be configured the same way as other quality plugins:
250+
251+
```groovy
252+
animalsniffer {
253+
toolVersion = extension.animalsnifferVersion
254+
ignoreFailures = !extension.strict
255+
sourceSets = extension.sourceSets
256+
}
257+
```
258+
208259
### Configuration
209260

210261
Use `quality` closure to configure plugin.
@@ -219,6 +270,7 @@ quality {
219270
pmdVersion = '5.4.1'
220271
findbugsVersion = '3.0.1'
221272
codenarcVersion = '0.24.1'
273+
animalsnifferVersion
222274

223275
// Enable/disable tools
224276

gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
version=1.0.4-SNAPSHOT
1+
version=1.1.0-SNAPSHOT

0 commit comments

Comments
 (0)