Controlling Github Autodeploys

Services that are linked to a GitHub repo automatically deploy when new commits are detected in the connected branch.

Configure the GitHub branch for deployment triggers

To update the branch that triggers automatic deployments, go to your Service Settings and choose the appropriate trigger branch.

Screenshot of GitHub Integration

Disable Automatic Deployments

To disable automatic deployment, simply choose Disable Trigger from your Service Settings.

Check Suites

To ensure Railway waits for your GitHub Actions to run successfully before triggering a new deployment, you should enable Check Suites.

Requirements

  • You must have a Github workflow defined in your repository.

  • The Github workflow must contain a directive to run on push:

Enabling Check Suites

If your workflow satisfies the requirements above, you will see the Check Suites flag in service settings.

Check Suites Configuration

Toggle this on to ensure Railway waits for your GitHub Actions to run successfully before triggering a new deployment.

When enabled, deployments will be moved to a WAITING state while your workflows are running.

If any workflow fails, the deployments will be SKIPPED.

When all workflows are successful, deployments will proceed as usual.


Edit this file on GitHub