Skip to content

Commit 40a90c6

Browse files
committed
Added setup information
1 parent 1fcd0df commit 40a90c6

File tree

2 files changed

+35
-16
lines changed

2 files changed

+35
-16
lines changed

README.md

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,40 @@ SonarQube plugin for supporting Android Lint
1616
### Plans
1717

1818
- Add support of custom lint checks
19-
- Implement sensor that run Android Lint analysis on its own (not just parsing `lint-results.xml` file)
19+
- Implement sensor that runs Android Lint analysis on its own (not just parsing `lint-results.xml` file)
20+
21+
### Settings
22+
23+
To specify Android Lint report file you can use `sonar.androidLint.reportPaths` property.
24+
25+
For example, in the project configuration
26+
27+
```groovy
28+
sonarqube {
29+
properties {
30+
property "sonar.androidLint.reportPaths", "build/reports/lint-results.xml"
31+
}
32+
}
33+
```
34+
35+
or SonarQube's project settings
36+
37+
![Settigns](docs/images/android-lint-settings.png)
38+
39+
### Usage
40+
41+
Get the latest version from the [Releases Page](https://github.com/jvilya/sonar-android-plugin/releases). Put the jar
42+
to
43+
`$SONAR_HOME/extensions/plugins` folder. Restart SonarQube.
44+
45+
Or build plugin by yourself
46+
47+
- `git clone https://github.com/jvilya/sonar-android-plugin`
48+
- `cd sonar-android-plugin`
49+
- `mvn package`
50+
- `cp target/sonar-android-lint-[enter_version].jar $SONAR_HOME/extensions/plugins`
51+
- `cd $SONAR_HOME/bin/[your_os]`
52+
- `./sonar.sh restart`
2053

2154
### Why?
2255

@@ -37,18 +70,4 @@ The support of external issues looks nice if you are ok with its limitations:
3770
> on the Rules page or reflected in Quality Profiles.
3871
> - external issues and the rules that raise them must be managed in the configuration of your linter.
3972
40-
As result this plugin was developed for providing the native SonarQube's experience to work with Android Lint issues.
41-
42-
### Usage
43-
44-
Get the latest version from [releases page](https://github.com/jvilya/sonar-android-plugin/releases). Put the jar to
45-
`$SONAR_HOME/extensions/plugins` folder. Restart SonarQube.
46-
47-
Or build plugin by yourself
48-
49-
- `git clone https://github.com/jvilya/sonar-android-plugin`
50-
- `cd sonar-android-plugin`
51-
- `mvn package`
52-
- `cp target/sonar-android-lint-[enter_version].jar $SONAR_HOME/extensions/plugins`
53-
- `cd $SONAR_HOME/bin/[your_os]`
54-
- `./sonar.sh restart`
73+
As a result, this plugin was developed for providing the native SonarQube's experience to work with Android Lint issues.
48.2 KB
Loading

0 commit comments

Comments
 (0)