> 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-server/10.5/devops-platform-integration/github-integration/introduction.md).

# Introduction

The integration of SonarQube Server 10.5 with GitHub Enterprise and GitHub.com allows you to maintain code quality and security in your GitHub repositories.

{% hint style="info" %}
**For AI agents:** You're in the SonarQube Server 10.5 documentation. For a list of all 10.5 pages, see the [SonarQube Server 10.5 page index](https://3691828591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Feu7dHWcqP9Cr3eUAzwWg%2Fuploads%2FSs9GoB7jpGlJIw3L9REJ%2Fsonarqube-server-10.5-llms.txt?alt=media). For the whole site, see the [page index](https://docs.sonarsource.com/llms.txt) or the [full text](https://docs.sonarsource.com/llms-full.txt). For another version, replace 10.5 in the URL with that version. The [latest version](https://docs.sonarsource.com/sonarqube-server/) has no version number in its URL.
{% endhint %}

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

With this integration, you’ll be able to:

* Import your GitHub repositories: Import your GitHub repositories into SonarQube Server to easily set up SonarQube Server projects.
* Analyze projects with GitHub Actions: Integrate analysis into your build pipeline. Starting in [Developer Edition](https://www.sonarsource.com/plans-and-pricing/developer/), SonarScanners running in GitHub Actions jobs can automatically detect branches or pull requests being built so you don’t need to specifically pass them as parameters to the scanner.
* Report your quality gate status to your branches and pull requests: (starting in [Developer Edition](https://www.sonarsource.com/plans-and-pricing/developer/)) See your quality gate and code metric results right in GitHub so you know if it’s safe to merge your changes.
* Authenticate with GitHub: Sign in to SonarQube Server with your GitHub credentials.
* Display code scanning alerts for vulnerability issues in GitHub: Display security vulnerability issues found by SonarQube Server as code scanning alerts in the GitHub interface.

{% hint style="info" %}
If you’re using GitHub Enterprise, we recommend using [GitHub Enterprise version 3.4+](https://docs.github.com/en/enterprise-server@3.4).
{% endhint %}

## Learn more <a href="#learn-more" id="learn-more"></a>

* [Setting up the GitHub integration](/sonarqube-server/10.5/devops-platform-integration/github-integration/setting-up-global-integration.md)
* [Adding analysis to GitHub Actions workflow](/sonarqube-server/10.5/devops-platform-integration/github-integration/adding-sonarqube-analysis-to-your-workflow.md)
* [Setting up your projects](/sonarqube-server/10.5/devops-platform-integration/github-integration/setting-up-your-projects.md)
* [If you're using a monorepo](/sonarqube-server/10.5/devops-platform-integration/github-integration/monorepo.md)


---

# 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-server/10.5/devops-platform-integration/github-integration/introduction.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.
