GitHub Integration

Coming Soon

GitHub integration is rolling out and is not yet available to all accounts.

Connect a GitHub repository to deploy your app when commits are pushed to the default branch, FastAPI Cloud downloads the commit, builds it in the cloud, deploys it, and reports progress back to GitHub.

Requirements

• A FastAPI Cloud account with access to the app’s team
• A GitHub account

If your FastAPI app is in a subdirectory, set the Root Directory when creating the app from GitHub, or configure the Application Directory in app settings.

Create an App from GitHub

To create a new app from a repository:

1. Open the FastAPI Cloud dashboard
2. Go to your team
3. Create a new app from GitHub
4. Connect your GitHub account if prompted
5. Install or update the FastAPI Cloud GitHub App if prompted
6. Select the GitHub account or organization
7. Select the repository
8. Set the Root Directory if your app is not at the repository root
9. Click Create App

FastAPI Cloud connects the repository to the app and deploys the latest commit on the default branch.

Connect GitHub to an Existing App

To connect GitHub to an existing app:

1. Open the app in the FastAPI Cloud dashboard
2. Go to Settings
3. Find Source Repository
4. Click Connect
5. Connect your GitHub account if prompted
6. Install or update the FastAPI Cloud GitHub App if prompted
7. Select the GitHub account or organization
8. Select the repository
9. Click Connect

FastAPI Cloud connects the repository and deploys the latest commit on the default branch.

To stop GitHub-triggered deployments for an app, disconnect the repository from the same Source Repository settings section. Existing deployments keep running.

Deployments from GitHub

FastAPI Cloud creates deployments when:

• You create an app from GitHub
• You connect a GitHub repository to an existing app
• A commit is pushed to the connected repository’s default branch

The same GitHub repository can be connected to more than one FastAPI Cloud app. Pushes to the default branch create deployments for each connected app.

Only pushes to the default branch trigger deployments. Pushes to other branches are ignored. Pull request preview deployments are not supported today.

Other branch workflows

If you need custom branch rules or a GitHub Actions workflow, use the Setup CI command or deploy tokens instead.

Update Repository Access

Change repository access from GitHub by editing the FastAPI Cloud GitHub App installation.

To revoke access entirely, remove the FastAPI Cloud GitHub App installation in GitHub. To stop deployments for one FastAPI Cloud app, disconnect the repository from that app’s Source Repository settings.

Troubleshooting

I Do Not See a Repository

Check that:

• Your GitHub account is connected to FastAPI Cloud
• The FastAPI Cloud GitHub App is installed on the repository owner
• The GitHub App installation includes the repository
• You selected the correct personal account or organization in the repository picker

A Push Did Not Deploy

Check that:

• The push was to the repository’s default branch
• The app is still connected to that repository
• The same commit was not already deployed for the app
• The app’s Application Directory points to the directory containing your FastAPI project

GitHub Status Is Missing or Stale

Check the deployment in FastAPI Cloud first. If the deployment exists there but GitHub status is missing, confirm the GitHub App still has access to the repository.