Connect to a GitHub repository

This page explains how to connect a GitHub repository to Cloud Build. To learn more about Cloud Build repositories, see Cloud Build repositories.

Before you begin

  • Enable the Cloud Build API.

    Enable the API

  • Have your source code ready in a GitHub repository.
  • Have either a Dockerfile or a Cloud Build config file in your GitHub source repository.
  • If you're initially connecting your repository to Cloud Build, make sure you have admin-level permissions on your repository. To learn more about GitHub repository permissions, see Repository permission levels for an organization.

  • To use gcloud commands on this page, install the Google Cloud CLI.

Connect to a GitHub repository

To connect your GitHub repository to your Cloud Build:

  1. Open the Repositories page in the Google Cloud console.

    Open the Repositories page

  2. In the project selector in the top bar, select your Google Cloud project.

  3. At the top of the page, select the 1st gen tab.

  4. Click Connect repository.

    You will see the Connect repository panel.

    1. Under Select source code management provider, select GitHub Cloud Build GitHub App.

    2. Click Continue.

      You may be asked to authenticate your connection to GitHub or install the GitHub App. If you have not already done so, complete the following steps:

      1. If you have not signed into GitHub before, do so now.

        The Authorization page appears, where you authorize the Google Cloud Build App to connect to Google Cloud.

        Screenshot of the authorize button

      2. Click Authorize Google Cloud Build by GoogleCloudBuild.

      3. Click Install Google Cloud Build.

      4. In the dialog that appears, select your GitHub username or organization.

      5. Select one of the following options based on your business need:

        • All repositories - enable current and future GitHub repositories for access using the Cloud Build app

        • Only select repositories - use the Select repositories drop-down to enable only specific repositories for access using the Cloud Build app.

        You can enable additional repositories at a later time. If you select All repositories as your option, the Cloud Build app is authorized to access all your repositories. However, you need to connect each new repository through Cloud Build following the steps outlined in this section.

      6. Click Install to install the Cloud Build app.

        The dialog closes and the Repositories page appears.

    3. In the Select repository section, select the following fields:

      • GitHub account: The GitHub account used to install the Cloud Build GitHub App. This field may be pre-selected for you.

      • Repository: The repositories you want to connect to Cloud Build.

      If you don't see one or more of your target repositories, click Edit repositories on GitHub to enable additional repositories in the Cloud Build GitHub App. You can then select your new target repository in the Select Repository section.

    4. Once you have selected your GitHub account and repositories, read the consent disclaimer and select the checkbox next to it to indicate that you accept the presented terms.

    5. Click Connect.

    6. (Optional) In the Create a trigger section, select the repositories you want to create a trigger for in the Create a sample trigger for these repositories field. Once you have selected your repositories, click Create a trigger.

    7. Click Done.

(Optional) Updating the authenticated GitHub account

If you need to update the GitHub account associated with your Google Account, you can navigate to the Authenticate with GitHub page. You may need to do this if you notice that the Cloud Build Connect Repository page indicates that the GitHub app is not installed on any repositories after installing the Cloud Build app on GitHub.

What's next