GitHub

Configure GitHub integration

To create integration between Brainboard and GitHub:

1. Go to the Git integration settings page.

2. Click on Integrations

3. Click on Connect with GitHub

You'll be redirected to the GitHub website, where you can choose the organization for which you want to configure access:

After selecting the organization, you are prompted to specify the repositories:

N.B: Brainboard requires read-write access to be able to do pull requests.

After selecting the repositories, you'll be automatically redirected to Brainboard Git app settings page. Now the button should have changed to View GitHub integration.

Once the connection is configured successfully, it will be you should it with a green indication

Enable personal connection

1. Once the GitHub app integration is done you need to click on Add connection in Personal connections section. This will open the settings where you can allow Brainboard to do pull requests on your behalf by clicking on Connect with Github

   

   If the Git app integration is not configured, Brainboard will display a warning as it has to be done first

   
2. The GitHub website will open in a new tab, asking you to authorize Brainboard app to access your GitHub account. Click on the Authorize Brainboard button:

   

   Github authorize
3. You will then be redirected to Brainboard personal git tokens page, with a confirmation that the GitHub connection was successful:

   

   Github_connection_success

Using your own GitHub app

Required if you want to integrate with GHE / GHES

Register a new app (see https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) with the following information:

• Name: Brainboard

• Homepage URL: https://www.brainboard.co

• Callback URLs:

  • https://app.brainboard.co/settings/integrations/git/callback/github/organization

  • https://app.brainboard.co/settings/integrations/git/callback/github/user

• Setup URL: https://app.brainboard.co/settings/integrations/git

• Webhook URL: https://api.us1.brainboard.co/webhooks/github

• Permissions:

  • Content: Read and write

  • Pull requests: Read and write

• Subscribe to events: none

Once created, generate a client secret and a private key then configure it in Brainboard.

Edit GitHub integration

To edit the GitHub integration:

1. Go to the Git integration settings page.

2. Click on Integrations

3. Click on Access GitHub

4. You'll be redirected to the GitHub website, where you can edit the integration with Brainboard.

Delete GitHub integration

To delete integration with GitHub:

1. Go to the Git integration settings page.

2. Click on Integrations

3. You need to delete your personal connection first by clicking on it in the section Personal connectio then click on Delete configuration

   
4. Go back to the page of Git connections and click on Access GitHub

5. You'll be redirected to the GitHub website, where you can delete the integration with Brainboard.

   

The update will be immediate, and you will no longer be able to do pull requests.