Deploy from GitHub

Deploying from Git is the most common way to run an application. Out Plane builds your repository and redeploys it whenever you push to the connected branch.

Connect a Repository

When you create an application, choose a source:

Source	Notes
GitHub	A repository from a connected account. Install the Out Plane GitHub App, grant the repositories you want, then pick one. Private repositories are supported, and you can filter the list by account or organization.
Public repo	Any public Git URL, entered as `github.com/owner/repo`. No GitHub App install is needed.

Configure the Build

Field	Notes
Name	Letters and numbers, 5 to 45 characters. A few common names are reserved.
Branch	The branch to deploy. Defaults to the repository's default branch.
Build method	Dockerfile or Buildpacks. See Build Configuration.
Root directory	The build context, for a monorepo or a subdirectory. Defaults to `/`.
Start command	Optional. Runs as a direct exec, so wrap shell features in `sh -c`. Leave empty to use the image default.

When the build method is Dockerfile, Out Plane scans the branch and root directory for a Dockerfile. If it finds one, it previews the file and prefills the ports and environment variables it detects.

Set the port your app listens on, add any environment variables, then select Deploy app.

How a Deployment Becomes Live

Build

Out Plane builds your source into a runnable image using the build method you chose. Follow the build log in the deployment.

Release

The new version replaces the previous one with no downtime, and the app becomes Running.

Auto-Deploy on Push

Once connected, pushing to the connected branch starts a new deployment automatically. Pushes to other branches do not deploy. To limit which changes trigger a build, use build filters.

Apps created from a public repo are built on demand and do not deploy automatically on push. You can always Redeploy from the Deployments tab.