Mirroring a GitHub Repository

This topic describes how to mirror a GitHub repository to Cloud Source Repositories. With this configuration, commits that you push to the GitHub repository are copied, or mirrored, into a repository hosted in Cloud Source Repositories.

Before you begin

When you mirror a repository, you must provide GitHub authentication credentials. These credentials allow Cloud Source Repositories to access the contents of the GitHub repository.

If you are using GitHub organizations, it is recommended that you use a machine user account that is specifically dedicated to automated tasks, such as mirroring a repository. This account must have administrative access to your repository.

Mirroring a GitHub repository

The following sections describe how to mirror a GitHub repository to Cloud Source Repositories.

Add a new repository

  1. Open the My Source view in the console:

    Open the Source View in the Console

  2. Click New Repository, located in the top right corner.

    The New Repository screen opens.

  3. Select Connect external repository.

  4. Click Continue.

    The Connect External Repository screen opens.

  5. From the Project list, select the project for the repository.

    To create a new project, click Create Project.

  6. From the Git Provider list, select GitHub.

  7. Check the box to authorize Cloud Source Repositories to store your credentials.

Connect to GitHub

In this step, you sign into GitHub and authorize Google Cloud Platform to have read access to the repository.

  1. Click Connect to GitHub.

  2. Sign in to GitHub using your machine user credentials.

  3. Click Authorize GoogleCloudPlatform.

    This option allows Google Cloud Platform read access to your repository.

    After the authorization concludes, you are returned to the Connect External Repository screen. A list of repositories opens.

  4. Select the repository you want to mirror.

  5. Click Connect Selected Repository.

The main repository screen opens. This screen contains a list of the repositories for this project, including the new repository you just created.

Identifying GitHub repositories

Cloud Source Repositories makes it easy to identify which of your repositories are mirrors of GitHub repositories:

  • Each GitHub repository is represented with the GitHub logo.
  • The name of the repository has github_ added to the beginning of its name.
Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Source Repositories