Skip to content
uploy docs

Connect a GitHub repository

Goal: Give uploy permission to read a GitHub repository and receive push webhooks from it.

Prerequisites:

  • A signed-in uploy account.
  • Admin rights on the GitHub account or organization that owns the repository.

Steps

Section titled “Steps”
  1. From any New app form, click Connect GitHub.
  2. GitHub asks which account to install the uploy GitHub App on. Choose your personal account or an organization.
  3. Choose Only select repositories (recommended) and pick the repos you want to deploy. You can also choose All repositories, but least privilege is safer.
  4. Click Install.
  5. You are returned to uploy. The repository picker now lists your selection.

Verify

Section titled “Verify”

Open the GitHub App’s settings page (GitHub → Settings → Applications → Installed GitHub Apps → uploy → Configure). You should see the repositories you granted. Webhooks are configured automatically.

Changing access later

Section titled “Changing access later”

Re-open the GitHub App configuration page and add or remove repositories there. Changes propagate to uploy within seconds.

Next steps

Section titled “Next steps”