Start Free
Latest | DevOps platform integration | GitHub integration | Importing GitHub repositories

Was this page helpful?

Importing your GitHub repositories into SonarQube

On this page

Once the integration of SonarQube with GitHub has been properly set up, you can import a GitHub repository to create the corresponding project in SonarQube. The so-created SonarQube project is "bound" to its GitHub repository. With a bound project:

  • You can see in the SonarQube UI with which repository the project is associated.
  • The quality gate status report to GitHub on pull requests is automatically set up.
  • The report of security alerts to GitHub can be set up.

To import a GitHub repository into SonarQube, do one of the following:

  • Import the GitHub repository from the SonarQube UI: see below.
    You need access to the GitHub repository and you need the Create Projects permission in SonarQube.
  • Analyze a repository from a GitHub action. SonarQube will create the corresponding project in SonarQube and will automatically bind it to the GitHub repository if it finds a matching GitHub integration configuration in its database. See Adding a SonarQube analysis to your GitHub Actions workflow.

Importing GitHub repositories

To import GitHub repositories into SonarQube:

  1. In the SonarQube UI, go to the Projects page and select the Create project > From GitHub command in the top right corner. 
  2. In the GitHub project onboarding page, select the GitHub organization and then the repository(ies) you want to import. 
  3. Select the Import button. The Clean as You Code setting page opens.
  4. Select the new code definition option.
  5. Select the Create projects button.

Importing a GitHub monorepo

See Managing the projects of a monorepo.

© 2008-2024 SonarSource SA. All rights reserved. SONAR, SONARSOURCE, SONARLINT, SONARQUBE, SONARCLOUD, and CLEAN AS YOU CODE are trademarks of SonarSource SA.

Creative Commons License