Importing GitHub organization

This page helps you understand how to import your GitHub organization into SonarQube Cloud and explains key details about modifying the necessary repository access rights.

When you import your GitHub organization or personal account to SonarQube Cloud, the corresponding Organization is created in SonarQube Cloud and is bound to the DevOps platform organization. Each SonarQube Cloud organization corresponds one-to-one with a GitHub organization or personal account. See Binding with the DevOps platform for more information.

SonarQube Cloud does not support linking an organization to more than one DevOps platform. If you want to link to more than one, you will need to create a separate organization to link to each DevOps platform.

The user account you used for the import is automatically assigned to the organization’s owners group which grants you administration rights on the organization. See User group concept for more details.

Prerequisites

• You must have the Administer Organization permission to create and manage a SonarQube organization. See Managing organization permissions for more information.

• You must be an owner of the GitHub organization.

• In SonarQube Cloud, each organization is assigned a subscription plan. Before importing your organization, choose the subscription plan suited to your needs, see Subscription plans for more details. In particular, determine the number of Lines of Code (LOC) you need. See LOC-based pricing for more information.

Importing the organization

To import your GitHub organization or personal account to SonarQube Cloud:

1

Create new organization

1. Log in to SonarQube Cloud with your GitHub account. If you’re a member of an enterprise, you may use any of your DevOps Platform accounts or your SSO account. In that case, see Using multiple accounts for important insights.

2. At the top right of the SonarQube Cloud interface, select the ✚ (plus) menu and then Create new organization. The Create an organization page opens.

2

Import from a DevOps platform

Under Import from a DevOps platform, select GitHub. The Install SonarQubeCloud page opens with the list of GitHub organizations you have access to. The SonarQube Cloud app is required to allow SonarQube Cloud to access your GitHub organization.

• If the GitHub organization you want to import has the SonarQube Cloud application already installed, it will be listed on the page with the Configure button.

• If this organization is not already bound to an organization in SonarQube Cloud, you will be able to import it after the configuration step. To do so, select it in the list. The application configuration opens in GitHub. Check the configuration and select the Save button. You’ll be redirected to SonarQube Cloud. You can then follow the instructions in step 4.

Select the GitHub organization you want to import.

3

Configure repository access

In Repository access, you can restrict access to the Git repositories that can be imported to SonarQube Cloud for analysis. You can always change this setting later, see Modifying the repository access rights of the organization. Once you’ve completed the app installation, you’ll be redirected to SonarQube Cloud’s Create an organization page.

4

Import organization details

In Import organization details, SonarQube Cloud suggests a GitHub Actions secret Name and Key for your SonarQube Cloud organization. The key is unique across all organizations within SonarQube Cloud. You can accept the suggestion or change it manually. You can't change it to an already existing key.

5

Auto-import new GitHub repositories (in beta)

The Auto-import new GitHub repositories (in beta) feature is enabled by default. From now on, this will automatically import newly added or created repositories in your GitHub organization into SonarQube Cloud without having to go through the manual new project analysis setup flow.

• As a requirement, All repositories must be selected in GitHub’s Repository Access settings, see step 3.

• Existing repositories in GitHub created prior to enabling the Auto-import new GitHub repositories feature are excluded.

• You can always disable this setting in Administration > Organization Settings > Organization binding.

• Note that a sudden spike in new repositories might cause you to reach your plan limits and pause analysis. Ensure the plan you select has enough allowance.

6

Additional information

Select Add additional info to add:

• Avatar: Enter a URL link to a small image representing the organization. The avatar is displayed on the UI near the organization’s name.

• Description: Add a description of the organization.

• URL: Enter the URL of the organization’s website to be displayed in the UI.

7

Select the subscription plan

1. Select the subscription plan for your organization. See Subscription plans for more details.

2. If you selected a paid plan, select the number of Lines of Code (LOC) for your plan and follow the instructions to enter your billing and payment information.

8

Create the organization

Click Create Organization to finalize the process and open the new organization.

If the import fails because the organization already exists in SonarQube Cloud and you’ve lost administrator access to this organization, send a request to [email protected] with all the necessary details.

Modifying the repository access rights of the organization

To modify the repository access rights of your GitHub organization:

1. Navigate to Administration > Organization Settings > Organization binding

2. Click on Repository Access settings link in the Auto-import new repositories section. You need a GitHub app admin permission to view the settings.

1. In GitHub, scroll down to Repository access, choose the access option and click Save.

Related pages

• Importing Bitbucket workspace

• Importing GitLab group

• Importing Azure DevOps organization

• Creating organization manually

• Binding an unbound organization

• Changing organization binding

• Changing organization settings

• Deleting organization