docs: fix SonarQube links (ef3aabd5) · Commits · to be continuous... / Maven

README.md

+7 −7

Original line number	Diff line number	Diff line
		@@ -122,17 +122,17 @@ This job uses the following variables:
		\| Input / Variable \| Description \| Default value \|
		\| ------------------------ \| -------------------------------------- \| ----------------- \|
		\| `sonar-host-url` / `SONAR_HOST_URL` \| SonarQube server url \| _none_ (disabled) \|
		\| :lock: `SONAR_TOKEN` \| SonarQube authentication [token](https://docs.sonarsource.com/sonarqube-server/latest/user-guide/managing-tokens/#using-a-token) (depends on your authentication method) \| _none_ \|
		\| :lock: `SONAR_LOGIN` \| SonarQube [login](https://docs.sonarsource.com/sonarqube-server/latest/extension-guide/web-api/#http-basic-access) (depends on your authentication method) \| _none_ \|
		\| :lock: `SONAR_TOKEN` \| SonarQube authentication [token](https://docs.sonarsource.com/sonarqube-server/user-guide/managing-tokens/#using-a-token) (depends on your authentication method) \| _none_ \|
		\| :lock: `SONAR_LOGIN` \| SonarQube [login](https://docs.sonarsource.com/sonarqube-server/extension-guide/web-api/#http-basic-access) (depends on your authentication method) \| _none_ \|
		\| :lock: `SONAR_PASSWORD` \| SonarQube password (depends on your authentication method) \| _none_ \|
		\| `sonar-base-args` / `SONAR_BASE_ARGS` \| SonarQube [analysis arguments](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/analysis-parameters/) \| `sonar:sonar -Dsonar.links.homepage=${CI_PROJECT_URL} -Dsonar.links.ci=${CI_PROJECT_URL}/-/pipelines -Dsonar.links.issue=${CI_PROJECT_URL}/-/issues` \|
		\| `sonar-quality-gate-enabled` / `SONAR_QUALITY_GATE_ENABLED` \| Set to `true` to enable SonarQube [Quality Gate](https://docs.sonarsource.com/sonarqube-server/latest/quality-standards-administration/managing-quality-gates/introduction/) verification.<br/>_Uses `sonar.qualitygate.wait` parameter ([see doc](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/ci-integration/overview/#quality-gate-fails))._ \| _none_ (disabled) \|
		\| `sonar-base-args` / `SONAR_BASE_ARGS` \| SonarQube [analysis arguments](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/analysis-parameters/) \| `sonar:sonar -Dsonar.links.homepage=${CI_PROJECT_URL} -Dsonar.links.ci=${CI_PROJECT_URL}/-/pipelines -Dsonar.links.issue=${CI_PROJECT_URL}/-/issues` \|
		\| `sonar-quality-gate-enabled` / `SONAR_QUALITY_GATE_ENABLED` \| Set to `true` to enable SonarQube [Quality Gate](https://docs.sonarsource.com/sonarqube-server/quality-standards-administration/managing-quality-gates/introduction/) verification.<br/>_Uses `sonar.qualitygate.wait` parameter ([see doc](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/ci-integration/overview/#quality-gate-fails))._ \| _none_ (disabled) \|

		#### Recommended minimal configuration

		1. set the `SONAR_HOST_URL` value either in your `.gitlab-ci.yml` file or as a project or group variable (:warning: setting it as a group variable will enable the SonarQube analysis for all the children projects),
		2. define your SonarQube credentials (:lock: `SONAR_TOKEN` or `SONAR_LOGIN` & :lock: `SONAR_PASSWORD`) as project or group variables,
		3. configure the project SonarQube settings in the `pom.xml` file (:warning: the [SonarScanner for Maven](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/scanners/sonarscanner-for-maven/#configuring-analysis) completely ignores the `sonar-project.properties` file):
		3. configure the project SonarQube settings in the `pom.xml` file (:warning: the [SonarScanner for Maven](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/scanners/sonarscanner-for-maven/#configuring-analysis) completely ignores the `sonar-project.properties` file):
		```xml
		<properties>
		<!-- the SonarQube project key -->
		@@ -141,7 +141,7 @@ This job uses the following variables:
		...
		</properties>
		```
		More info about [SonarQube settings](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/scanners/sonarscanner-for-maven/#analyzing)
		More info about [SonarQube settings](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/scanners/sonarscanner-for-maven/#analyzing)

		:warning: if using [SonarCloud](https://docs.sonarsource.com/sonarqube-cloud/) (a cloud-based SonarQube-as-a-Service), you'll have to define the additional `sonar.organization` property ([see mandatory-parameters](https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/analysis-parameters/#mandatory-parameters)).

		@@ -156,7 +156,7 @@ This job uses the following variables:

		#### Automatic Branch Analysis & Merge Request Analysis

		This template relies on SonarScanner's [GitLab integration](https://docs.sonarsource.com/sonarqube-server/latest/devops-platform-integration/gitlab-integration/introduction/), which is able to auto-detect whether to launch Branch Analysis or Merge Request Analysis
		This template relies on SonarScanner's [GitLab integration](https://docs.sonarsource.com/sonarqube-server/devops-platform-integration/gitlab-integration/introduction/), which is able to auto-detect whether to launch Branch Analysis or Merge Request Analysis
		from GitLab's environment variables.

		:warning: This feature also depends on your SonarQube server version and license.

kicker.json

+3 −3

Original line number	Diff line number	Diff line
		@@ -63,7 +63,7 @@
		},
		{
		"name": "SONAR_TOKEN",
		"description": "SonarQube authentication token (see https://docs.sonarsource.com/sonarqube-server/latest/user-guide/managing-tokens/) - depends on your authentication method",
		"description": "SonarQube authentication token (see https://docs.sonarsource.com/sonarqube-server/user-guide/managing-tokens/) - depends on your authentication method",
		"secret": true
		},
		{
		@@ -78,13 +78,13 @@
		},
		{
		"name": "SONAR_BASE_ARGS",
		"description": "SonarQube [analysis arguments](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/analysis-parameters/)",
		"description": "SonarQube [analysis arguments](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/analysis-parameters/)",
		"default": "sonar:sonar -Dsonar.links.homepage=${CI_PROJECT_URL} -Dsonar.links.ci=${CI_PROJECT_URL}/-/pipelines -Dsonar.links.issue=${CI_PROJECT_URL}/-/issues",
		"advanced": true
		},
		{
		"name": "SONAR_QUALITY_GATE_ENABLED",
		"description": "Enables SonarQube [Quality Gate](https://docs.sonarsource.com/sonarqube-server/latest/quality-standards-administration/managing-quality-gates/introduction/) verification.\n\n_Uses `sonar.qualitygate.wait` parameter ([see doc](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/ci-integration/overview/#quality-gate-fails))._",
		"description": "Enables SonarQube [Quality Gate](https://docs.sonarsource.com/sonarqube-server/quality-standards-administration/managing-quality-gates/introduction/) verification.\n\n_Uses `sonar.qualitygate.wait` parameter ([see doc](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/ci-integration/overview/#quality-gate-fails))._",
		"type": "boolean"
		}
		]

templates/gitlab-ci-maven.yml

+6 −6

Original line number	Diff line number	Diff line
		@@ -53,18 +53,18 @@ spec:
		description: SonarQube server url
		default: ''
		sonar-base-args:
		description: SonarQube [analysis arguments](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/analysis-parameters/)
		description: SonarQube [analysis arguments](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/analysis-parameters/)
		default: >-
		sonar:sonar
		-Dsonar.links.homepage=${CI_PROJECT_URL}
		-Dsonar.links.ci=${CI_PROJECT_URL}/-/pipelines
		-Dsonar.links.issue=${CI_PROJECT_URL}/-/issues
		sonar-quality-gate-enabled:
		description: 'Enables SonarQube [Quality Gate](https://docs.sonarsource.com/sonarqube-server/latest/quality-standards-administration/managing-quality-gates/introduction/)
		description: 'Enables SonarQube [Quality Gate](https://docs.sonarsource.com/sonarqube-server/quality-standards-administration/managing-quality-gates/introduction/)
		verification.


		_Uses `sonar.qualitygate.wait` parameter ([see doc](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/ci-integration/overview/#quality-gate-fails))._'
		_Uses `sonar.qualitygate.wait` parameter ([see doc](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/ci-integration/overview/#quality-gate-fails))._'
		type: boolean
		default: false
		dependency-check-disabled:
		@@ -226,8 +226,8 @@ variables:
		# Maven build arguments
		MAVEN_BUILD_ARGS: $[[ inputs.build-args ]]
		# Sonar base analysis default args
		# see: https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/analysis-parameters/
		# default uses branch analysis: https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/branch-analysis/introduction/
		# see: https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/analysis-parameters/
		# default uses branch analysis: https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/branch-analysis/introduction/
		SONAR_BASE_ARGS: $[[ inputs.sonar-base-args ]]
		# Dependency Check arguments
		MAVEN_DEPENDENCY_CHECK_ARGS: $[[ inputs.dependency-check-args ]]
		@@ -674,7 +674,7 @@ mvn-sonar:
		stage: test
		extends: .mvn-base
		variables:
		# see: https://docs.sonarsource.com/sonarqube-server/latest/devops-platform-integration/gitlab-integration/setting-up-at-project-level/
		# see: https://docs.sonarsource.com/sonarqube-server/devops-platform-integration/gitlab-integration/setting-up-at-project-level/
		SONAR_USER_HOME: "${CI_PROJECT_DIR}/${MAVEN_PROJECT_DIR}/.sonar" # Defines the location of the analysis task cache
		GIT_DEPTH: 0 # Tells git to fetch all the branches of the project, required by the analysis task
		cache: