Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@xvik
xvik committed Feb 9, 2023
1 parent 192a3dc commit 060d07f
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ buildscript {
mavenCentral()
}
dependencies {
classpath 'ru.vyarus:gradle-animalsniffer-plugin:1.6.0'
classpath 'ru.vyarus:gradle-animalsniffer-plugin:1.7.0'
}
}
apply plugin: 'ru.vyarus.animalsniffer'
Expand All @@ -78,7 +78,7 @@ OR

```groovy
plugins {
id 'ru.vyarus.animalsniffer' version '1.6.0'
id 'ru.vyarus.animalsniffer' version '1.7.0'
}
```

Expand All @@ -92,7 +92,7 @@ The plugin is compiled for Java 8, and is compatible with Java 11.

Gradle | Version
--------|-------
5-7 | 1.6.0
5-7 | 1.7.0
4.x | [1.4.6](https://github.com/xvik/gradle-animalsniffer-plugin/tree/1.4.6)

### Usage
Expand All @@ -103,6 +103,8 @@ Additional tasks will be assigned to the `check` task. So animalsniffer checks w
$ gradlew check
```

NOTE: in case of configuration problems use `animalsniffer.debug` option to see actual task configuration

#### Signatures

AnimalSniffer requires a signature file to check against. To define a signature (or multiple signatures) use
Expand Down Expand Up @@ -299,17 +301,18 @@ animalsniffer {

There are no required configurations - the plugin will generate defaults for all of them.

| Property | Description | Default value |
|----------|-------------|-------------------------------------------------|
| toolVersion | AnimalSniffer version | 1.22 |
| sourceSets | Source sets to check | all source sets |
| ignoreFailures | False to stop build when violations found, true to continue | false |
| reportsDir | Reports directory | file("$project.buildDir/reports/animalsniffer") |
| annotation | Annotation class to avoid check under annotated block | |
| ignore | Ignore usage of classes, not mentioned in signature | |
| signatures | Signatures to use for check | `configurations.signature` |
| Property | Description | Default value |
|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| toolVersion | AnimalSniffer version | 1.22 |
| sourceSets | Source sets to check | all source sets |
| ignoreFailures | False to stop build when violations found, true to continue | false |
| debug | Log animalsniffer configuration (useful in case of configuration problems) | false |
| reportsDir | Reports directory | file("$project.buildDir/reports/animalsniffer") |
| annotation | Annotation class to avoid check under annotated block | |
| ignore | Ignore usage of classes, not mentioned in signature | |
| signatures | Signatures to use for check | `configurations.signature` |
| excludeJars | Patterns to exclude jar names from classpath. Required for [library signatures](https://github.com/xvik/gradle-animalsniffer-plugin/wiki/Library-signatures) usage | |
| cache | [Cache configuration](https://github.com/xvik/gradle-animalsniffer-plugin/wiki/Check-task-performance) | By default, cache disabled |
| cache | [Cache configuration](https://github.com/xvik/gradle-animalsniffer-plugin/wiki/Check-task-performance) | By default, cache disabled |

**NOTE**: `ignore` does not exclude your classes from check, it allows you to use classes not mentioned in the signature.
See more details above.
Expand Down

0 comments on commit 060d07f

Please sign in to comment.