Gitlab integration

Enabling the integration is very easy. Head over to your project and open the projects settings window. Scroll to the "Gitlab" section and copy the URL behind "Webhook POST URL".

You have to configure a Web hook in Gitlab to allow Breeze to receive commit messages.

Set up the Web hook in Gitlab

1. Go to https://gitlab.com and log in.
2. Click on the Projects link on the left side menu.

3. Choose your project from the page. The Project page opens.

4. Click on the Settings link at the bottom of the left side menu.

5. Click on "Web hooks" on the left side menu. The Web hook configuration page opens.

6. Enter the Breeze POST URL to the URL input. This is the one you got from Breeze under the project settings.

7. Press Add Web hook.

Now the hook is created and Breeze is ready to receive commit messages and issues.

Syncing Gitlab issues

You can create Breeze tasks from Gitlab issues. To enable this check the "Issues events" option in Gitlab Web hook settings. We also update Breeze tasks whenever you make changes to Gitlab issues.

Gitlab commits

Breeze lets you to manipulate the status of tasks within your projects directly from your repository commit messages. Breeze parses the commit messages and closes, moves or tracks time on tasks. Every commit will also add a comment to the task with the commit message.

The commands that can be used in your commit messages are as follows:

1. Reference task - #task_id, will reference the tasks and add a comment to it.
2. Mark as done - fix,fixes,fixed,close,closed,closes,done #task_id will change the status of the specified task to "done".
3. Move task to list - #task_id m:ListName will move the task to the specified list. The list name is case insensitive, if you have spaces in the name use camel case (ListName) .
4. Track time - #task_id t:1:30 will create a time entry with a given number of hours for the specified task You can use multiple formats for the time string - 1h, 1h30m, 1:30, 30m.
5. Mention users - @username will create mention notification for the user.

Here are some examples of how to use the commands:

git commit -am '#3672, #3673 and #8623 and closes #5126'

git commit -am 'log time , #4326 t:1:30'

git commit -am 'move to done, #4326 m:done'

If you want to combine multiple commands then you have to refrence the task each time.

git commit -am 'mark as #432 done, move to doing #432 m:doing, track time #432 t:1:30'

To be able to track time, your git commiter email must match your Breeze email. You can set your git email using:

git config user.email "user@domain.com"