Add a GitHub Repository

If your repository lives in GitHub, you can connect your repository automatically, or connect via SSH if you prefer.

If you prefer SSH, buddybuild will automatically generate a secure SSH key for you to install into your source control system. Buddybuild will use this key to clone your repository.

Important

Buddybuild has first-class integrations with the following repo providers:

Buddybuild’s integrations provide the following features:

  • Commit status updates

  • Support for pull request workflows

  • Integration with issue tracking

  • Selective builds

  • Federated login

  • Automated access management

  • Ability to select from available repositories

If you choose to use SSH to connect to your repo, buddybuild can only access your repository’s file content, and the features noted above do not work.

Let’s get started!

Note

Quick Links

Step 1: Enter the SSH Git Clone URL

Within the main page of your repository, look for the green Clone or Download button and click it to reveal a dropdown window. Click on Use SSH.

A GitHub project screen, showing the Clone or Download dropdown menu to select SSH

With SSH selected, copy the SSH URL by clicking the copy to clipboard button.

Clicking the Copy to clipboard button on the GitHub project screen

Head over to dashboard, visit Select source and choose SSH.

The buddybuild Select source screen

Paste the SSH URL you copied into the Git clone URL field.

The buddybuild Connect another Git service screen

Step 2: Add the SSH Key to Your GitHub Account

Highlight and copy the generated SSH key.

The buddybuild Connect another Git service screen, with SSH key selected

Navigate to your GitHub Account by first selecting your account photo, and then selecting Settings.

A GitHub project screen with account dropdown menu open

In the left navigation, select SSH keys.

The GitHub account settings screen

Next, select Add SSH key.

The GitHub account SSH keys screen

Enter Buddybuild as the title, and paste the copied SSH key into the key field.

Pasting the buddybuild SSH key into the GitHub account SSH keys screen

Next, click Add key.

Clicking the Add key button on the GitHub account SSH keys screen

Warning

Private git submodules and private cocoapods

If your project depends on any code in other private git repos, the SSH key needs to be added to those repos as well.

Navigate back to buddybuild and click on the Build button.

The buddybuild Connect another Git service screen

Buddybuild clones your project code and starts a simulator build. The build should finish within a few minutes.

That’s it! Your GitHub repository is now connected to buddybuild, and your first build is under way. The next steps are:

results matching ""

    No results matching ""