On this page

Deploy via GitHub

Guara Cloud integrates directly with GitHub to provide automatic deployments on every push. When you push to the configured branch, a new deployment is triggered automatically.

Installing the GitHub App

To connect your repositories, you need to install the Guara Cloud GitHub App on your GitHub account or organization.

  1. Go to GitHub settings

    In the Guara Cloud dashboard, navigate to Settings > GitHub or click “Connect GitHub” when creating a service.

  2. Install the Guara Cloud App

    You will be redirected to GitHub. Choose whether to grant access to all repositories or only specific ones.

  3. Confirm the installation

    After authorizing, you will be redirected back to Guara Cloud. Your repositories will be available for connection.

Connecting a repository

After installing the GitHub App, you can connect a repository to any service:

  1. Go to the service page in the dashboard
  2. In the Source section, click Connect Repository
  3. Select the repository from the list
  4. Choose the branch that triggers automatic deployments (for example, main)
  5. For monorepos, set the root directory of the service (for example, /apps/api)

Deploy branch

The configured branch is the one that triggers automatic deployments. When you push to this branch, Guara Cloud:

  1. Detects the changes via webhook
  2. Starts building the new version
  3. Deploys automatically when the build completes

You can change the deploy branch at any time in the service settings.

Monorepo support

If you use a monorepo (multiple projects in the same repository), Guara Cloud offers path filtering. This means the deployment is only triggered when files within the configured directory are changed.

For example, if the service root directory is /apps/api:

Changed fileTriggers deploy?Reason
apps/api/src/main.tsYesInside apps/api
apps/api/package.jsonYesInside apps/api
apps/web/src/page.tsxNoDifferent directory
README.mdNoRoot-level file

Disconnecting GitHub

You can disconnect GitHub from a service at any time:

  1. Go to the service page
  2. In the Source section, click Disconnect
  3. Confirm the action

When you disconnect, the service keeps running with its last successful deployment, but automatic deployments are disabled. You can reconnect the same repository or a different one at any time.

If you uninstall the Guara Cloud App directly from GitHub, all connected services will be disconnected automatically.