> For the complete documentation index, see [llms.txt](https://django-cloud.gitbook.io/django-cloud-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://django-cloud.gitbook.io/django-cloud-docs/getting-started/github.md).

# Deploy by pushing to GitHub

Connect a repository and every push to a branch creates a new release, with no CI pipeline to write.

## Connect a repository

1. Open your deployment in the dashboard and go to **Settings**.
2. Install the DjangoCloud GitHub App on your account or organisation, and choose which repositories it may read.
3. Back in the dashboard, pick the repository and the branch (the default branch is suggested).

From then on, a push to that branch queues a release, builds it and deploys it. Each push to the branch creates one release, and if GitHub delivers the same push twice only one release is made.

## What the app can do

* It gets **read-only** access to the repositories you choose, to fetch the code to build.
* Each build uses a short-lived token for that single repository.
* It reports build status back to the commit on GitHub.

## Good to know

* Only pushes to the **connected branch** deploy. Other branches are ignored.
* If your account is suspended for non-payment, pushes are ignored and the log says so.
* If you uninstall the GitHub App, the project is disconnected from the repository. Existing deployments keep running.
* Build settings are read from `.djangocloud/config.json` in the repository, so commit that file. See [Build settings](/django-cloud-docs/how-it-works/build-settings.md).

{% hint style="info" %}
You can still deploy from your laptop at any time. `djangocloud deploy --github` deploys the linked repository's latest commit instead of your local folder.
{% endhint %}


---

# 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://django-cloud.gitbook.io/django-cloud-docs/getting-started/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.