{ "componentChunkName": "component---src-templates-plugin-docs-tsx", "path": "/plugins/scm-sonar-plugin/docs/latest/en/config/", "result": {"data":{"plugin":{"name":"scm-sonar-plugin","displayName":"Sonar integration","description":"Shows CI status for Sonar analysis","author":"Cloudogu GmbH","documentation":[{"version":"3.0.x","languages":["de","en"]},{"version":"1.1.x","languages":["en","de"]},{"version":"1.0.x","languages":["de","en"]}]},"navigation":{"nodes":[{"section":"Configuration","entries":[{"frontmatter":{"title":"Configuration","subtitle":"Sonar Webhooks Setup","partiallyActive":null},"fields":{"slug":"/plugins/scm-sonar-plugin/docs/3.0.x/en/config/"}}]}]},"versions":{"group":[{"fieldValue":"1.0.x"},{"fieldValue":"1.1.x"},{"fieldValue":"3.0.x"}]},"languages":{"group":[{"fieldValue":"de"},{"fieldValue":"en"}]},"markdownRemark":{"html":"

Setup

\n

The Sonar plugin allows to receive Sonar analyses that can be sent by SonarQube or SonarCloud via webhooks.\nFor this purpose, the plugin provides two REST endpoints to evaluate the analysis result of the webhooks and attach it to the analysed commit in the repository.\nThe setup of the webhooks should hardly differ in the tools.

\n

SonarCloud Webhook

\n

In SonarCloud webhooks can be defined per project or per organization.\nThe webhooks are triggered automatically after running an analysis, regardless of the analysis result.\nThe recommended procedure for setting up Sonar webhooks against the SCM Manager server is presented here.

\n

Example

\n

We set up a new webhook for our Sonar project. For this we choose as URL the endpoint in SCM-Manager: https://{instanceUrl}/scm/api/v2/sonar.\nFor this webhook to be accepted at the SCM manager, credentials must be sent along.\nThis usually involves choosing a technical user who must have the rights to write CI statuses.\nUsername and password can be written in the front part of the URL, e.g. https://Testuser:Password123@{instanceUrl}/scm/api/v2/sonar.\nInstead of the password we can also use a SCMM API key.\nThe payload of the Sonar webhook is automatically generated from the analysis data.

\n

In order for the SCM-Manager to recognize which repository it is when it receives the webhook, the repository name must be supplied with the special key sonar.analysis.scmm-repo.\nThe value of the key must contain {repositoryNamespace}}/{repositoryName}}.

\n

Example of triggering a SonarCloud analysis:\nsonarqube -Dsonar.organization=scm-manager -Dsonar.branch.name=develop -Dsonar.analysis.scmm-repo=scm-manager-plugins/scm-tagprotection-plugin

\n

For more information on Sonar webhooks, see the documentation.

\n

\n \n \n

","description":"Setup The Sonar plugin allows to receive Sonar analyses that can be sent by SonarQube or SonarCloud via webhooks.\nFor this purpose, the plugin provides two REST…","tableOfContents":"","frontmatter":{"title":"Configuration","subtitle":"Sonar Webhooks Setup","description":null,"keywords":null,"displayToc":null,"image":null}}},"pageContext":{"name":"scm-sonar-plugin","slug":"/plugins/scm-sonar-plugin/docs/3.0.x/en/config/","version":"3.0.x","latestVersion":"3.0.x","latestPageVersion":"3.0.x","language":"en","canonicalPath":"/plugins/scm-sonar-plugin/docs/latest/en/config/","latestRootPath":"/plugins/scm-sonar-plugin/docs/3.0.x/en/"}}, "staticQueryHashes": ["1973669194","2742214048","2956773653","2957019495","698804963"]}