add sonar-scanner-cli docs (#8)

This commit is contained in:
MikeBirnstiehl 2020-06-01 11:04:22 -05:00 committed by GitHub
parent da6dc19b2c
commit 7826fc8dc8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 26 additions and 0 deletions

View File

@ -0,0 +1,22 @@
# What is SonarScanner CLI?
[SonarScanner](https://redirect.sonarsource.com/doc/install-configure-scanner.html) is the official scanner used to run code analysis on SonarQube and SonarCloud.
# How to use this image
To analyze your repository, you have to:
- Define your configuration in the `sonar-project.properties` file in the root of your source code repository.
- Pass your source code to the scanner. Your source code repository should be mounted to the container `/usr/src` directory.
- Pass your SonarQube or SonarCloud URL in the SONAR_HOST_URL environment variable. The default URL is `http://localhost:9000`, but you'll most likely need to change it to fit your setup.
- Run the following command:
```console
docker run \
--rm \
-e SONAR_HOST_URL=http://${SONARQUBE_URL} \
-v "${YOUR_REPO}:/usr/src" \
sonar-scanner-cli
```
For more details on how to use the image, visit the [SonarScanner](https://redirect.sonarsource.com/doc/install-configure-scanner.html) page in the SonarQube documentation.

View File

@ -0,0 +1 @@
[the SonarSource Community forum](https://community.sonarsource.com/tags/c/help/sq/docker), [the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](https://blog.docker.com/2016/11/introducing-docker-community-directory-docker-community-slack/), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)

View File

@ -0,0 +1 @@
https://github.com/SonarSource/sonar-scanner-cli-docker

View File

@ -0,0 +1 @@
View [license information](http://www.gnu.org/licenses/lgpl.txt) for the software contained in this image.

BIN
sonar-scanner-cli/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.1 KiB

View File

@ -0,0 +1 @@
[SonarSource](%%GITHUB-REPO%%)