Unverified Commit ced2ca04 authored by Timothy Stone's avatar Timothy Stone
Browse files

docs: mvn-sonar notes and usage 

Update the README to with reference to TBC Usage for additional context to disable the job when
SONAR_HOST_URL is defined.
parent bd93ab3a

README.md

+7 −2
Original line number Diff line number Diff line
@@ -69,11 +69,11 @@ More info: 
* [Maven Surefire Plugin](https://maven.apache.org/surefire/maven-surefire-plugin)

* [`surefire:test` parameters](https://maven.apache.org/surefire/maven-surefire-plugin/test-mojo.html)



### SonarQube analysis job

### `mvn-sonar` job — SonarQube analysis



This job is **disabled by default** and performs a SonarQube analysis of your code.



It is bound to the `test` stage, and uses the following variables:

The job is bound to the `test` stage and uses the following variables:



| Name                     | description                            | default value     |

| ------------------------ | -------------------------------------- | ----------------- |
@@ -94,6 +94,11 @@ If using Community Edition, you'll have to install the [sonarqube-community-bran 


:warning: Merge Request Analysis only works if you're running [Merge Request pipeline](https://docs.gitlab.com/ee/ci/yaml/workflow.html#switch-between-branch-pipelines-and-merge-request-pipelines) strategy (default).



#### Disable the job



> :information_source: See [Usage](https://to-be-continuous.gitlab.io/doc/usage/#example-3-disable-go-mod-outdated-job) 

> for more information about disabling any job that MAY not be required in a project or group.



### `mvn-dependency-check` job



This job enables a manual [Dependency-Check](https://jeremylong.github.io/DependencyCheck/dependency-check-maven/configuration.html)