> 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/github-deployments.md).

# GitHub deployments

In your Account Settings, you can configure Release to create GitHub deployments when your environments are created and deployed.

Under the **Source Control** tab in Account Settings:

![](https://585411240-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M1neGLLQ0sDXeK6ooSo%2Fuploads%2Fgit-blob-362cbe5bcd30837438c9cbd4bbd1e2356ff5ea78%2Fgithub-settings-2.png?alt=media)

The "Pull request deployment updates" setting is off by default. Turn this setting on to create deployments. If you're unfamiliar with GitHub deployments, please refer to the GitHub [deployments](https://docs.github.com/en/rest/deployments) documentation.

Release will create:

* A **pending** deployment when the environment is created.
* A successful deployment if the environment successfully deploys.
* A deployment error if something goes wrong while deploying the environment.

![](https://585411240-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M1neGLLQ0sDXeK6ooSo%2Fuploads%2Fgit-blob-28808e0c6ad93c297a5e1038eae62c96dcb08c88%2Fgithub-deployment-releasehub.png?alt=media)

The format of the name for the deployment is `<App Name>: <User Name>-<Environment Name> (<Environment Handle>)`. The **View deployment** button will appear if your application has a single hostname. If your application has multiple hostnames, you can set a [Primary App Link](/reference-documentation/application-settings/primary-app-link.md) to let Release know which hostname it should use.


---

# 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/github-deployments.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.