GitLab

The integration allows to:

• retrieve messages in the card's comments that contain links to commit's related to that card;

• automatically link to Flowfast cards in every commit in GitLab

• automatically move cards to a selected column when a branch is created in the repository;

• automatically move cards to a selected column when the card's branch is inserted into a specified branch in the repository;

Setting up

GitLab repository setup

1. Open the menu. Under Spaces, hover your cursor over the space which events you want to integrate into the calendar. Click on the three dots to the right of the space name, then in the drop-down menu click "Space settings"

2. In the window that opens, go to the GitLab section. There will be GitLab Secret and Webhook URL for your company. Under "Integrations with repositories" click "Create integration".

3. In the window that opens type in

• The repository name. For example, it is new-dev in the line https://gitlab.com/koshkarik/new-dev

• Prefix

Using a specified prefix you have an ability to receive comments in FlowFast withs link the to GitLab commit on every commit.

Specify a prefix and use this prefix in commit messages. For example, for the prefix ABC, the commit message could be the following bug fix ABC-157834. (It is also possible to specify multiple cards with a comma and no spaces #XXXXX,YYYYYY)

Setting up integration in GitLab

• In GitLab, choose Settings → Webhooks from the menu. 

• Enter your Webhook URL and Gitlab Secret. 

• Click the Add webhook button.

Automatic card movements

A card can be moved automatically: 

- when a branch with card ID in its name is created

- when a branch with card ID in its name is merged to a specific branch

Select the board/column to which the card will automatically be moved depending on the event

Now if you create a branch in your project with name, e.g. branch-XXXX, where XXXX is your card id, the card will be moved to the column which is specified for the branch created event. How the branch is named does not matter, as long as the card's ID is there.

Links to FlowFast cards in GitLab

If you set up FlowFast as an external issue tracker in GitLab, then if there are card ID's in the commits, GitLab will make such ID's links to cards in FlowFast. This functionality is provided by GitLab.https://docs.gitlab.com/ee/user/project/integrations/custom_issue_tracker.html

To set up an external issue tracker, go to integration and select "Custom issue tracker".

Next, add links to FlowFast (in the image below, enter your FlowFast domain instead of your_domain).

After saving these settings, GitLab will substitute ID's in commits with links to cards in Flowfast.

Example of integration settings

Using a card with ID 100 as an example:

When creating a branch, e.g. fix-branch-100, the card will move to the Gitlab Tests / To do column;

After merging with the master branch, the card will be moved to the Gitlab Tests / Done column.

Checking integration

Adding commit-based comments to a card

1) If prefix is specified in settings, only comments with prefix will be added;

2) By default # is used instead of the prefix (example commit message: bug fix #12345)

3) Prefix in commit message must match completely with prefix from settings (layout, case of letters)

4) Completely removing the settings for the repository resets the prefix setting. You should now use # in the commit message to create comments

5) Push Events in GitLab interface should be enabled in settings (Settings → Webhooks → Integration with FlowFast by url. For example, https://hq.flowfast.io/gitlabwh)