> 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/setting-up-your-projects.md).

# Setting up your projects

After creating and installing your GitHub App, SonarQube Server 10.5 can report your quality gate status and metrics directly to your GitHub branches and pull requests.

{% 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 %}

For general information about project creation and import, see [Creating and importing projects](/sonarqube-server/10.5/project-administration/creating-and-importing-projects.md).

## Reporting your quality gate status in GitHub <a href="#reporting-your-quality-gate-status-in-github" id="reporting-your-quality-gate-status-in-github"></a>

After [Setting up the GitHub integration](/sonarqube-server/10.5/devops-platform-integration/github-integration/setting-up-global-integration.md), SonarQube Server can report your quality gate status and analysis metrics directly to your GitHub branches and pull requests.

To do this, add a project from GitHub by doing one of the following:

* On the **Projects Overview** page, select **Add project** > **GitHub**, and follow the steps in SonarQube Server to analyze your project.
* Scan a project from a GitHub action. SonarQube Server will find a matching GitHub configuration.

SonarQube Server automatically sets the project settings required to show your quality gate in your branches and pull requests.

{% hint style="info" %}
To report your quality gate status in your branches and pull requests, a SonarQube Server analysis needs to be run on your code. You can find the additional parameters required for pull request analysis on the [Pull request analysis](/sonarqube-server/10.5/analyzing-source-code/pull-request-analysis.md) page.
{% endhint %}

If you’re creating your projects manually or adding quality gate reporting to an existing project, see the following section.

### Reporting your quality gate status in manually created or existing projects <a href="#reporting-your-quality-gate-status-in-manually-created-or-existing-projects" id="reporting-your-quality-gate-status-in-manually-created-or-existing-projects"></a>

SonarQube Server can also report your quality gate status to GitHub pull requests and branches for existing and manually created projects. After you’ve created and installed your GitHub App and updated your global DevOps Platform Integration settings as shown in the **Importing your GitHub repositories into SonarQube** section above, set the following project settings at **Project Settings** > **General Settings** > **DevOps Platform Integration**:

* **Configuration name**: The configuration name that corresponds to your GitHub instance.
* **Repository identifier**: The path of your repository URL.

### Showing your analysis summary under the GitHub Conversation tab <a href="#showing-your-analysis-summary-under-the-github-conversation-tab" id="showing-your-analysis-summary-under-the-github-conversation-tab"></a>

Make sure that for your project, **Enable analysis summary** under the **GitHub Conversation** tab in **Project settings > General settings > Pull Request Decoration** is on (default value). If it’s the case, your pull request analysis will be shown under both the **Conversation** and **Checks** tabs in GitHub. When off, your pull request analysis summary is only shown under the **Checks** tab.


---

# 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/setting-up-your-projects.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.