Macro Usage

The plugin is quite easy to use. Once you have setup your SonarQube servers, you just need to use the SonarQube Connector Macro to setup the resource you want to get metrics from.

You have to complete two parameters:

  • SonarQube server: this is a dropdown list with the SonarQube servers configured through the plugin settings.

  • Resource Key: this is the key of the SonarQube resource to retrieve the quality metrics. You can get this key from your SonarQube project dashboard or your sonar-project analysis parameters. 

    • Note: Enterprise portfolio are also supported you can enter the portfolio name here.

  • Tags :This is an optional field. You can get the projects through the tags associated with them in SonarQube/SonarCloud. These tags can be obtained from your project page in SonarQube/SonarCloud or from the analysis properties. You can configure more than one tag by specifying a comma separated list of tags. The results will be aggregated in a single view with all the resources together.

  • Custom metrics: List of custom metric keys to display in the page, you can specify one metric key or a list of metric keys separated by commas. For example: blocker_violations, major_violations, classes. Check with your SonarQube administrator to find out the keys to the available metrics

  • Branch: Name of the branch (visible in the SonarQube UI)

    • Only available on single project configuration



Setting multiple resource keys