Skip to content
Club Docs

GitHub

Club integrates with GitHub, allowing for two-way synchronization between the two platforms. This is a great option for teams working with one or more GitHub repositories, allowing them to sync issues and changes while utilizing Club’s other features for scheduling, planning and collaboration.

Integrating a GitHub account

Click on your user profile icon at the bottom of the left sidebar and select Integrations. Below “GitHub integration”, click Add.

Click Authorize Club GitHub App. When prompted, click Authorize Club GitHub App again and if needed, enter your login information for your GitHub account.

You will be brought back to Club, where you can see your GitHub information in the GitHub integration window.

Mapping GitHub repositories

To connect a GitHub repository to Club, select Mapped GitHub Repositories on the Github integration window. Click Install GitHub App.

On the next screen, select a location to install Club GitHub. You may be prompted to enter your GitHub login information. Select which repositories you would like Club GitHub to have access to.

Your selected repository will now display in the Mapped GitHub Repositories tab. Use the dropdown Connect to Club to select which Project you’d like to add your repository to. Alternatively, you can create a new Project to sync with your repository.

Your repository can be disconnected at any time by clicking the Disconnect button.

How Club interacts with GitHub

You can use the Club platform to interact with your GitHub repository in a number of ways, including:

  • Creating and syncing issues - Issues created within the project linked to your GitHub will by default create a matching issue in your repository (this can be overridden by selecting Create issue without GitHub). When multiple repositories are connected, you can select which one to create the issue in using the Create issue in dropdown menu. Similarly, when you create a new issue on GitHub, it will appear on the Club platform as well. Once an issue has been created in your GitHub repository, you can find the direct link to it in the Activity section for that issue on Club.

  • Pull requests - Pull requests from GitHub automatically appear in the pull requests tab, available within your Project in the Tracker Sidebar.

  • Comments - Commenting on an issue connected with a GitHub repository using the Club interface will also automatically create a comment on the corresponding issue in GitHub. Likewise, any comment added to an issue on GitHub will appear on that Issue in the Club platform.