> For the complete documentation index, see [llms.txt](https://docs.release.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.release.com/integrations/source-control-integrations/github.md).

# GitHub

## Authorization

Release uses [GitHub Apps](https://docs.github.com/en/developers/apps/about-apps) to allow you to control Release authorization to access and interact with your code on GitHub.

![GitHub App Permissions Screen](https://585411240-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M1neGLLQ0sDXeK6ooSo%2Fuploads%2Fgit-blob-cbfd9595d860030cb0834b4653e00b4dbe79680d%2Fgithub-app-permissions.png?alt=media\&token=f63aa6a5-f41b-401c-a490-b824fce1ea58)

When you install the `release-com` app to your organization, Release will request the following permissions:

* **Read access to code and metadata:** To pull your code and create builds for your applications.
* **Read and write access to commit statuses, deployments, issues, and pull requests:** To interact with different features GitHub has built. All of these interactions are configurable in Release and are described in the child pages.

You can give Release access to all your repositories or only select repositories.

Webhooks Release listens for:

* **Code push:** Update an environment with the latest code on a branch.
* **New pull request:** Create an ephemeral environment for the branch in the pull request.
* **Reopen pull request:** Recreate an environment when a pull request is reopened.
* **Closed pull request:** Destroy an ephemeral environment when the pull request is closed or merged.
* **Labels on pull requests:** Create an ephemeral environment when the pull request receives a specific label.


---

# 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.release.com/integrations/source-control-integrations/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.
