Frequently Asked Questions
What is the syntax for commit messages to affect ticket status?
If a project is setup to process commit messages, the following commands entered into your commit log message have the potential to affect ticket status:
close, closed, closes, fix, fixed, fixes The specified issue numbers are closed with the contents of this commit message being added to it. references, refs, addresses, re, see The specified issue numbers are left in their current status, but the contents of this commit message are added to their notes.
When processing the log message, commit messages are searched for text in the following form:
command #1 command #1, #2 command #1 & #2 command #1 and #2
Instead of the short-hand syntax "#1", "ticket:1" can be used as well. For example:
command ticket:1 command ticket:1, ticket:2 command ticket:1 & ticket:2 command ticket:1 and ticket:2
In addition, the ':' character can be omitted and issue or bug can be used instead of ticket.
You can also have more than one command in a message. A fairly complicated example of what you can do is with a commit message of:
Changed blah and foo to do this or that. Fixes #10 and #12, and refs #12.
This will close #10 and #12, and add a note to #12.
Timing and Estimation Plugin
If you have the Timing and Estimation Plugin enabled, then there is support for specifying time spent in commit messages. The time specified will be automatically added to the spent time field for the ticket.
Blah refs #12 (spent 1.5) Blah refs ticket:12 (sp 1) Blah fixes #12 (2.5)
As above it is possible to use complicated messages:
Changed blah and foo. Fixes #10 (1) and #12 (2), and refs #13 (0.5).
This will close #10 and #12, and add a note to #13; and also add 1h spent time to #10, add 2h spent time to #12, and add 30m spent time to #13.
Agilo Plugin
Finally, if you have the Agilo Plugin enabled, then there is support for specifying the remaining time for a ticket in the commit message.
Blah remaining #12:2h Blah still ticket:12:1h Blah fixes #12, time #13:4h