Set up a Version Control System Integration

With the Clubhouse GitHub integration, specially formatted commit messages can be used to link stories to commits, branches and pull requests, as well as move stories across your workflow. Following these instructions, you can configure the Clubhouse GitHub integration to work with one or more GitHub repositories.

 

Setting up the integration in Clubhouse

1. In the Clubhouse app, click the User icon in the lower left corner, click Integrations, and then click GitHub.
2. Click Add Account.

Setting up the integration in GitHub

 

After clicking Add Account in Clubhouse, you will be taken to GitHub to select which GitHub account to link. From this next screen, you can authorize access to all repositories in the account, or only select repositories.

Once all or the select repos have been selected, click Install. You will be redirected back to Clubhouse to this message:

 

 

Connecting Individual Accounts

Individuals will need to ensure that their primary email address in GitHub is the same as one of their email addresses in Clubhouse. In GitHub, check your personal account settings, under the email tab.

If this is not the same email address used to create your Clubhouse account, you'll need to add that email address to Clubhouse.

To set up your integration to use our Event Handlers, follow these instructions. When you're done, make sure to check out our the guide to using our VCS integrations with PRs and Branches.

For self-managed GitLab users: Our GitLab integration needs to talk to the API of your self-managed GitLab install to properly process some event payloads. It determines the address of the API using the URLs included in the webhook payloads, and that address needs to be publicly accessible for us to reach it. Non-resolvable hostnames will cause the integration to not work correctly.

 

Setting up the integration in Clubhouse

Only Admins and Owners can activate this integration in Clubhouse. In the Clubhouse app, click the User icon in the upper right corner, click Integrations, and then click GitLab. Click the Slider to enable, then copy the GitLab Payload URL and open your GitLab account.

Next, check that the correct events will be sent to Clubhouse. Click the checkbox for:

• Push Events
• Comments
• Merge request events

You may optionally include Confidential Comments.

If you are not using GitLab's Group webhooks, be sure that you've added the GitLab Payload URL to the Integrations Settings for each Project that should send data to Clubhouse. Add user(s) email address as public in GitLab in order for Clubhouse's event handler to determine which GitLab user performed certain actions in Clubhouse, we match the email from GitLab payload to that of the Clubhouse user. Ensure that the public email in Settings (under user icon) > Main Settings is set to the appropriate email for the user in Clubhouse.

The last step is to place a personal access token from GitLab into Clubhouse. You may use an individual user's token, but it is recommended that you create a bot user in GitLab. 

 

1. Create a new user on your GitLab.com organization. Consider using a name that signifies this user connects GitLab to Clubhouse, like 'Clubhouse Bot'.

2. In GitLab, invite your bot user to the Projects that you want Clubhouse to access, and grant that user Developer permissions.

3. Log in with the bot user account and open the User Settings.

4. Generate a personal access token scoped to have API access  

 

 

 

5. Copy the personal access token and paste it into the API Access Token field in the GitLab integration pane. Click Update API Access Token to save the token value.

 

GitLab Event Handlers

 

Setting up the integration in Clubhouse

Only Admins and Owners can activate this integration in Clubhouse. In the Clubhouse app, click the Gear icon in the upper right corner, click Integrations, and then click Bitbucket. Click the Slider to enable, then click Connect to Bitbucket.