Introduction

Introduction to GitHub integration with SonarQube Community Build.

SonarQube’s integration with GitHub allows you to maintain code quality and security in your GitHub repositories.

With this integration, you’ll be able to:

• Sign in to SonarQube Community Build with your GitHub credentials.

• Import your GitHub repositories into SonarQube to easily set up SonarQube projects.

• Analyze projects with GitHub Actions: Integrate analysis into your build pipeline.

SonarQube Community Build doesn’t support various features such as the analysis of multiple branches and pull requests. See Feature comparison table to know which GitHub integration features are supported by the other SonarQube deployments.

Prerequisites

You can use any GitHub plan. If you use GitHub Enterprise Server, we recommend using GitHub Enterprise version 3.14+.

Related pages

• Introduction to Setting up the GitHub integration at the global level. This section explains how to set up GitHub and SonarQube for their integration at the global level. You need the global Administer System permission in SonarQube to perform this setup.

• Importing GitHub repositories Once the integration of SonarQube with GitHub has been properly set up, you can import a GitHub repository to create the corresponding projects in SonarQube.

• Adding analysis to GitHub Actions workflow Once you have created your projects in SonarQube Server, you can add the SonarQube Server analysis to your GitHub Actions workflow.