GitHub services

A GitHub service follows one branch of a repository. Deploy builds the branch's latest commit and runs it like a Docker service, with the same environment variables, volumes, domains, versions and logs.

Connect GitHub first in Settings → Integrations (see GitHub integration).

Create a serviceCopy Anchor Link

Pick a repository the GitHub App is installed on, then a branch. The branch can be changed later in the service's settings; the next deploy builds the new branch's latest commit.

How it buildsCopy Anchor Link

• With a Dockerfile at the root of the branch, it builds that file.
• Without one, Railpack detects the stack and builds it. The app must listen on its domain's port, for example through a PORT variable set on the service.

Builds run with rootless BuildKit inside the cluster, and images are pushed to the platform's own registry. The service overview lists builds with their log. A build can be cancelled from the console.

Build commandsCopy Anchor Link

The Build section of Configuration overrides Railpack's install, build and start commands, for example npm ci, npm run build and npm run start. A Dockerfile build ignores them. Changing one rebuilds on the next deploy.

A deploy whose image already comes from the branch's latest commit, built with the current commands, skips the build.

Deploy on pushCopy Anchor Link

A push to the branch deploys a service that was deployed before. Turn off Deploy on push in the service's settings to deploy only by hand. A push during a build cancels that build.

Not supported yetCopy Anchor Link

• A Dockerfile path or build context other than the repository root
• Build arguments, and build-time variables for Railpack builds
• GitHub Enterprise Server