Skip to content

Install the Plugin

Günter Wirth edited this page Jan 20, 2021 · 17 revisions

                 Before you start, back up your SonarQube Database.
      Upgrade problems are rare, but you'll want the backup if anything does happen.

  • Use the cxx plugin Compatibility Matrix to select the correct plugin version for the SonarQube version you are using. SonarQube versions are based on different Java versions and also have different APIs and UIs.

    Hint: The CXX plugin competes with the SonarCFamily plugin and is therefore not supported by SonarSource in the Marketplace.

  • Download one of the released JAR packages and copy it into the SONARQUBE_HOME/extensions/plugins directory. Details can be found under Install a Plugin, Manual Installation.

    • sonar-cxx-plugin-x.y.z.jar: is the CXX plugin
  • Restart the SonarQube server to load and activate the plugin.

  • Navigate to the Marketplace inside of SonarQube (Administration > Marketplace). The Marketplace should list CXX (Community) on the Installed tab.

  • Discover and update the CXX-specific properties in: Administration > General Settings > CXX and Administration > General Settings > CXX External Analyzers

  • If you use the sonar.cxx.other.reportPaths sensor, you should configure the rules before scanning for the first time. Otherwise, any existing issues will be closed and displayed later in New Code.

  • Also remember to check the Quality Profile on a new server. Are the rules you are using enabled?

Additional tools:

  • sslr-cxx-toolkit-x.y.z.jar: is an additional tool to create an AST from parsed source code. The tool is useful to create XPath checks and to verify if the plugin can parse the source code.

    sslr-cxx-toolkit-x.y.z.jar is not a plugin. Do not copy it to the plugins folder.

Clone this wiki locally