Github integration

Enabling the integration is very easy. Head over to your project and open the projects settings window. Click on the "Link GitHub repos" button. You'll be taken to GitHub page for authentication and after that you'll be redirect back to Breeze.

Breeze configures a post web hook to GitHub that allows us to receive commit messages. By enabling the integration you we'll be also shown the task ID on every card, this makes it possible for you to reference them in commit messages.

You must have admin rights to the repo to configure push hooks.

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"