Unreal Cloud DocsGitHub Integration
Connect a repository, build automatically on GitHub events, and mirror status back as check runs.
Unreal Cloud connects to GitHub through a GitHub App installed on your repository. The connection powers automatic builds and mirrors build status back to GitHub as check runs.
Connecting a repository
Open your project's Settings tab.
Under Version control, click Connect GitHub.
In the GitHub window that opens, install the Unreal Cloud GitHub App on the user or organization that owns your repository. You can grant access to a single repository — that's all Unreal Cloud needs.
Back in the dashboard, select the repository for this project.
One repository per project
The project page shows the current connection state. If the app is uninstalled or loses access on the GitHub side, a banner appears and automatic builds stop until the connection is repaired.
What triggers builds
After connecting, GitHub events are matched against your presets:
| GitHub event | Matching presets | What gets built |
|---|---|---|
| Push | Push presets whose branch matches the pushed branch | The pushed branch |
| Pull request opened or updated | Pull Request presets whose base-branch filter matches the PR's base branch | The PR's head commit |
Presets with trigger None ignore GitHub events entirely.
Check runs on commits and PRs
Every automatically triggered build creates a GitHub check run on the commit it builds. As the build progresses, the check run updates:
| Build status | Check run |
|---|---|
queued / scheduled / running | In progress |
passed | Success |
failed | Failure |
canceled | Cancelled |
On pull requests this appears in the checks section, so you can see at a glance whether a PR builds — and optionally make it a required check in your branch protection rules.
Manually triggered builds do not create check runs.
Changing or removing the connection
From project settings you can switch the connected repository or uninstall the GitHub App. Uninstalling stops all automatic builds for the project; existing builds and artifacts are unaffected.