Skip to content
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.

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

Update sonar-scanner url in README #49

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ execute each one of them individually on your project. Once they are running fin
parse their reports.
>
> Note 2: The lein plugin versions above are the ones we currently support. If you would like to test with a different
version, keep in mind that it might cause errors on SonarClojure analysis.
version, keep in mind that it might cause errors on SonarClojure analysis.

2. Create a ***sonar-project.properties*** file in the root folder of your app:

Expand All @@ -49,7 +49,7 @@ version, keep in mind that it might cause errors on SonarClojure analysis.
sonar.sources=.
```

3. Run [sonar-scanner](https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner) on your project.
3. Run [sonar-scanner](https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/) on your project.

### Configuring Sensors

Expand All @@ -75,11 +75,11 @@ file.
#### Debugging
* SonarClojure is in its early days and therefore you might face problems when trying to run the plugin, especially because
we rely on other plugins that are also in its early days. A nice way to try to debug
a problem you might have is to make sure the particular plugin you are using is running fine before executing the
a problem you might have is to make sure the particular plugin you are using is running fine before executing the
sonar-scanner. For instance, if you are trying to visualize the coverage data on SonarQube, make sure to run cloverage
against your project using `lein cloverage --codecov` for instance. Once you fix the cloverage issue on your project,
then SonarClojure should be able to parse the results. The same idea applies to all the plugins.

* In general, plugins should not stop execution in case of errors, unless an exception happens.

* You can use `-X` or `--debug` when running sonar-scanner to get a detailed information of what SonarClojure is trying to do.
Expand Down