> For the complete documentation index, see [llms.txt](https://docs.sonarsource.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sonarsource.com/sonarqube-cloud/discovering-sonarcloud/integration-with-devops-platforms/github.md).

# GitHub

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

{% hint style="success" %}
To get started analyzing your GitHub projects with SonarQube Cloud, see [Getting started with GitHub](/sonarqube-cloud/getting-started/github.md).
{% endhint %}

SonarQube Cloud’s integration is supported with GitHub plans running on the [github.com](https://github.com/) domain, on the ghe.com domain used for GitHub Enterprise Cloud with Data Residency, and on GitHub Enterprise Server (GHES).

## Key features <a href="#key-features" id="key-features"></a>

With this integration, you’ll be able to:

* Authenticate with GitHub.com through the SonarQube Cloud GitHub application. Automatic member synchronization is supported only for GitHub.com organizations.
* Import your GitHub organization and its repositories into SonarQube Cloud to easily set up SonarQube Cloud projects. The following additional features are supported:
  * The auto-import of new GitHub repositories.
  * The bulk import of all existing repositories.
  * The automatic analysis of the projects’ main branch.
* Analyze projects with GitHub Actions. SonarScanners running in GitHub Actions jobs can automatically detect branches or pull requests being built. You can fail the job if the SonarQube quality gate fails.
* Report your quality gate status to your branches and pull requests. You can see your quality gate and code metric results right in GitHub so you know if it’s safe to merge your changes. You can prevent pull request merges when the quality gate fails.
* Display security issues found by SonarQube Cloud as code scanning alerts in the GitHub interface (not yet supported with GHE.com Cloud or GHES).
* Import your monorepo into SonarQube Cloud to easily manage the related projects.

## Authentication and member access

The **GitHub** login option and [GitHub member synchronization](/sonarqube-cloud/administering-sonarcloud/about-sonarqube-cloud-solution/user-management/github-member-synchronization.md) support GitHub.com only. For GHE.com and GHES, use SSO. See [Importing GHE.com Cloud organization](/sonarqube-cloud/administering-sonarcloud/managing-organization/creating-organization/importing-ghecom-cloud-organization.md#signing-in-to-sonarqube-cloud) or [Importing GHES organization](/sonarqube-cloud/administering-sonarcloud/managing-organization/creating-organization/importing-ghes-organization.md#signing-in-to-sonarqube-cloud).

## Related pages

* [Getting started with GitHub](/sonarqube-cloud/getting-started/github.md)
* [Github Actions](/sonarqube-cloud/analyzing-source-code/ci-based-analysis/github-actions-for-sonarcloud.md)
* [Importing GitHub.com organization](/sonarqube-cloud/administering-sonarcloud/managing-organization/creating-organization/importing-github-organization.md)
* [Importing GHE.com Cloud organization](/sonarqube-cloud/administering-sonarcloud/managing-organization/creating-organization/importing-ghecom-cloud-organization.md)
* [Importing GHES organization](/sonarqube-cloud/administering-sonarcloud/managing-organization/creating-organization/importing-ghes-organization.md)
* [Creating your project](/sonarqube-cloud/managing-your-projects/administering-your-projects/setting-up-project.md#creating-manually)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sonarsource.com/sonarqube-cloud/discovering-sonarcloud/integration-with-devops-platforms/github.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.