Skip to content

GitHub Sync

GitKraken Boards and GitKraken Timelines has sunset at the end of 2022. The below information and features may be out of date. Please read our full announcement and FAQ to learn more.

Syncing your GitHub Issues in GitKraken Boards lets you break issues out into columns and visualize them.

What gets synced from GitHub?

  • GitHub Issues
  • Assignees
  • Description
  • Comments
  • Labels

Connect to GitHub

The button is available from the bottom of the left Boards panel in GitKraken Boards.

You can also connect to GitHub from the Integrations section of the User Options menu.

Click the button, login to GitHub, and authorize GitKraken Boards.

Your GitHub account should now be connected to GitKraken Boards!

Create a Synced Board

Open the Boards panel and click on the button.

Search for the GitHub repo issue board you wish to sync.

GitKraken Boards has a max syncing limit of 1,000 issues. If you have repos with 1,000+ issues you wish to sync, consider first archiving older issues in GitHub.

Note: You must be an administrator for the GitHub repo to create the initial synced board. The repo name will be grayed out with a lock icon if you don't have administrator permissions on that repo.

IMPORTANT: If you don't see your repo in the list search, your organization needs to grant permissions for GitKraken and GitKraken Boards in GitHub.

Click the button to confirm that you wish to sync this board with GitKraken Boards.

GitHub synced boards will be indicated by the GitHub logo to the left of the board name.

Important: GitKraken Boards's GitHub Sync relies on a repo webhook created during the sync set up. Please do not modify or remove this webhook as this will cause the GitHub sync to fail.

Managing Synced Boards

When you first sync a board, you will start out with just one column in GitKraken Boards. However from here you can create more columns and build out the workflow for your issues.

From here, new issues added to GitHub will now sync to GitKraken Boards.

Conversely, new cards added to GitKraken Boards will also be synced to GitHub. You may need to refresh GitHub to see the new issue.

Type the GitHub issue number in the search field to quickly find corresponding card.

Also, if you ever want to jump to the GitHub issue from GitKraken Boards, click on this icon to access the link:

Milestones

Any milestones that you create in Github Issues will be added to GitKraken Boards, and any milestones you create in GitKraken Boards will be respected in Github (you will need to refresh GitHub to view any changes).