Connect GitHub

Convoy Cloud deploys directly from your GitHub repositories. To get started, you need to install the GitHub App and grant access to your workspace.

Step 1: Install the GitHub App

1. Navigate to Integrations in the sidebar.
2. Under GitHub App, click Install GitHub App.
3. You will be redirected to GitHub to install the Convoy Cloud app on your personal account or GitHub organization.
4. Choose which repositories to grant access to — you can select All repositories or pick specific ones.
5. Click Install to complete the installation.

The GitHub App installation is tied to your Convoy Cloud user account, not your workspace. You only need to install it once per GitHub account.

Step 2: Grant access to your workspace

After installing the GitHub App, you need to share the installation with your Convoy Cloud workspace:

1. Back on the Integrations page, you will see your GitHub installation listed.
2. Click Grant to Workspace to share your repository access with the current workspace.

When granting access, you choose which repositories the current workspace can see:

• All repositories -- Convoy Cloud can access every repository in your GitHub account or organization, including repositories added in the future.
• Selected repositories -- only the repositories you explicitly choose are accessible. You can add or remove specific repos at any time from GitHub Settings.

The same GitHub installation can be shared with multiple Convoy Cloud workspaces.

Private repositories

Convoy Cloud fully supports private repositories. When you install the GitHub App and grant access, Convoy Cloud receives the necessary permissions to clone your private repositories during builds. No additional configuration is needed.

Managing access

Changing which repositories Convoy Cloud can see

To add or remove repositories after the initial installation:

1. Go to GitHub Settings > Applications > Convoy Cloud (on GitHub.com).
2. Click Configure next to the Convoy Cloud app.
3. Update the repository access list and save.

Changes take effect immediately in Convoy Cloud.

Revoking access

To fully remove the GitHub App from your account:

1. Go to Integrations in the Convoy Cloud sidebar.
2. Click Revoke or Disconnect next to your GitHub installation.

You can also uninstall the app directly from GitHub Settings > Applications > Convoy Cloud > Uninstall.

Next steps

With GitHub connected, you are ready to deploy your first application.