Github and Gitlab

Github and Gitlab

Setting up the Github or Gitlab integration is vital to ensure that code changes are associated with the correct work items. This will allow the team to all stay in sync with the status of code changes.

To install the integration, go to "Manage integrations" either in the ⚙️ next to your organization name, or in the Kitemaker command (cmd/ctrl+k), and select the Github or GitLab integration to set up the integration.

💡

Our GitHub and GItLab integrations support automatically moving work items via Automation, so if you are looking for that, please check out the automation section as well.

Linking to work items

There are three ways to make code changes appear in work items:

  • Mention the work item in the commit message
  • Mention the work item in the merge/pull request description, or
  • Use a so-called “magic branch”

Mentioning work items in messages is straightforward. Just ensure that the work item number (the ABC-123 visible on every work item) is in the description. You can easily copy the work item number from a board or the work item screen by pressing Cmd/Ctrl+i.

Using so-called magic branches, every commit and pull/merge request will be linked to the work item.

image

Magic branches can be created by having the work item number in the branch name. Kitemaker will also automatically generate personal magic branch names for each work item. To use them, simply click the branch icon on the top of the work item screen, or press cmd/ctrl+shift+g.

image

Merge/pull requests

Notice that Kitemaker will show the status of every merge/pull request. It will be shown in the activity feed:

image

On cards and on the top of work items we will also show an icon showing the status of merge/pull requests. If there is at least one open request, we will show the “open merge/pull request” icon, and if you hover this icon you will see a list of all the merge/pull requests associated with the work item:

This work item has an open pull request in Github
This work item has an open pull request in Github
These are all the pull requests associated with the work item, with status
These are all the pull requests associated with the work item, with status