Connect a repository with kedge connect. Pushes to its production branch
deploy automatically; pull requests from branches in the same repository
receive isolated previews.
connect a repository
You need permission to install a GitHub App for the personal account or organization that owns the repository.
- Sign in to Kedge with GitHub.
- Run
kedge connect, or choose connect a repo from the apps page. - On GitHub, choose the repository owner and grant access to the repositories you want to use.
- Back on Kedge, choose a repository and select connect.
Kedge imports the default branch and deploys it immediately. The app retains its Git history, so local pushes, the browser editor, and GitHub webhooks all feed the same deploy pipeline.
If a repository is missing from the picker, adjust the GitHub App installation's repository access.
automatic deploys
After a repository is connected:
- a push to its production branch deploys a new version;
- a pull request from a branch in the same repository gets an isolated preview for a single-service app;
- new commits update that preview;
- closing the pull request removes it;
- checks and deployment statuses link to the build log and preview.
The production branch defaults to the repository's default branch. Set
top-level x-kedge.production-branch to override it.
Fork pull requests do not deploy because their code is not trusted with the repository's deployment authority. Multi-service Compose apps deploy their production branch but do not yet create branch previews.
A failed build or readiness check never takes production traffic. See zero-downtime cutover and builds & images.
The same App installation can also run the repository's Actions jobs on Kedge. See GitHub Actions runners.
remove access
Removing a repository from the GitHub App installation stops future webhook
deploys. The app remains deployed; use kedge delete <app> to remove it.