GitHub Integration

đź“š Learn more about GitHub action features, integrations and alternatives.

Adding a GitHub integration allows you to use GitHub as your Git hosting provider. This way you can create pipelines that build, test, and deploy the code stored in GitHub repositories.

The GitHub integration uses GitHub Apps to get the necessary account information and access the respositories you want to use in Buddy.

GitHub Apps integration was introduced in November 2021. Every new project connected to a GitHub repository must use this integration. Projects created before November 2021 remain fully functional and require no action as they continue using the legacy, OAuth-based integration.

To learn more, read this blog post.

Setting up a GitHub integration

  1. Add a new project and choose GitHub as the Git hosting provider.
  2. In the GitHub popup window, click Authorize Buddy to grant Buddy access to the required information from your GitHub account.

Permission requirements screenPermission requirements screen

  1. Select which organization's repositories you want to use in Buddy:

Selecting GitHub organizationSelecting GitHub organization

  1. Decide whether you want to give Buddy access to all your repositories within the selected organization, or if you want to limit the permissions to a single repository. Confirm your choice by entering your GitHub password.

Selecting the scope of repository accessSelecting the scope of repository access

  1. Back in Buddy, name your project and choose the repository you want to use. Choosing the repositoryChoosing the repository

When you create the project, Buddy adds a webhook to your repository. This allows to trigger deployments whenever new commits are pushed to the repo when using the On Push pipeline execution trigger mode.

The contents of the connected repository are reproduced in read-only mode. To view them, go to the Code tab, where you can also browse the files and view commit history.

Managing repository access

After adding the integration, you can adjust its access scope or change the GitHub organizations the integration works with.

Follow these steps:

  1. Select Integrations from the left navigation panel.
  2. Find the GitHub integration you want to adjust on the integrations list.
  3. Click Set permissions to open a GitHub popup window.

Integration settings in BuddyIntegration settings in Buddy

  1. In the popup window, click the organization name you are already using to change the access scope or revoke access. Choose an organization you haven't used before to configure it and start using it in Buddy.

Choosing the repositoryChoosing the repository

Look for the word "Configure" to identify the organization(s) you are already using in Buddy.

"Configure" marks organizations that are in use"Configure" marks organizations that are in use