SonarQube Documentation

SonarQube, is a self-managed, automatic code review tool that systematically helps you deliver Clean Code. As a core element of our Sonar solution, SonarQube integrates into your existing workflow and detects issues in your code to help you perform continuous code inspections of your projects. The tool analyses 30+ different programming languages and integrates into your CI pipeline and DevOps platform to ensure that your code meets high-quality standards.

Writing Clean Code

Writing Clean Code is essential to maintaining a healthy codebase. We define Clean Code as code that meets a certain defined standard, i.e. code that is reliable, secure, maintainable, readable, and modular, in addition to having other key attributes. This applies to all code: source code, test code, Infrastructure as Code, glue code, scripts, etc.

Sonar's Clean as You Code approach eliminates many of the pitfalls that arise from reviewing code at a late stage in the development process. The Clean as You Code approach uses your Quality Gate to alert/inform you when there’s something to fix or review in your New Code (code that has been added or changed), allowing you to maintain high standards and focus on code quality.

Developing with Sonar

Development Cycle

The Sonar solution performs checks at every stage of the development process:

  • SonarLint provides immediate feedback in your IDE as you write code so you can find and fix issues before a commit.
  • SonarQube’s PR analysis fits into your CI/CD workflows with SonarQube’s PR analysis & use of Quality Gates.
  • Quality Gates keep code with issues from being released to production, a key tool in helping you incorporate the Clean as You Code methodology.
  • The Clean as You Code approach helps you focus on submitting new, Clean Code for production, knowing that your existing code will be improved over time.

Learn more about the types of issues that SonarQube detects.

Organizations start off with a default set of rules and metrics called the Sonar Way Quality Profile. This can be customized per project to satisfy different technical requirements. Issues raised in the analysis are compared against the conditions defined in the Quality Profile to establish your Quality Gate.

A Quality Gate is an indicator of code quality that can be configured to give a go/no-go signal on the current release-worthiness of the code. It indicates whether your code is clean and can move forward.

  • A passing (green) Quality Gate means the code meets your standard and is ready to be merged.
  • A failing (red) Quality Gate means there are issues to address.

SonarQube provides feedback through its UI, email, and in decorations on pull or merge requests (in commercial editions) to notify your team that there are issues to address. Feedback can also be obtained in SonarLint supported IDEs when running in Connected Mode. SonarQube also provides in-depth guidance on the issues telling you why each issue is a problem and how to fix it, adding a valuable layer of education for developers of all experience levels. Developers can then address issues effectively, so code is only promoted when the code is clean and passes the Quality Gate.

Getting Started

Now that you've heard about how SonarQube can help you write Clean Code, you are ready to try out SonarQube for yourself. You can run a local non-production instance of SonarQube and initial project analysis. Installing a local instance gets you up and running quickly, so you can experience SonarQube firsthand. Then, when you're ready to set up SonarQube in production, you'll need to Install the Server before configuring your first code analysis.

The Analyzing Source Code section explains how to set up all flavors of analysis, including how to analyze your project’s branches and pull requests.

More Getting Started Resources

Learn More

Check out the entire suite of Sonar Products: SonarQube, SonarCloud, and SonarLint.

Staying Connected

Use the following links to get help and support: