View Source

Commit command is used in commit message to update or progress issues. It has below syntax:
{code}
COMMAND_NAME ISSUE_KEY [ISSUE_KEY ...] [--OPTION1 VALUE1] [--OPTION2 VALUE2]
{code}

For example, the command below means: command name is _Fix_, issues are _TST-1_, _TST-2_ and TST-3, with one attribute _comment_ which value is _implemented a cool feature_
{code}
Fix TST-1, TST-2 and TST-3 --comment implemented a cool feature
{code}


*Normally, one command is in one line*, if you need multiple line for an attribute, a '\' should be added to the end of line, for example:
{code}
Fix TST-1 --comment First line \
Second line \
Third line
{code}

*Command Name*

The action can be customized when you add an *Update Issue Step*. The action in commit command is case-insensitive that means Fix TST-1 is equals to fix TST-1 or FIX TST-1.

*Issue Key*
The issue key is issue tracker related. You can customize it in related issue tracker settings by using [Java regular expression|http://java.sun.com/j2se/1.5.0/docs/api/java/util/regex/Pattern.html].

*Command Option*

Command options in a commit command use defined attributes in issue tracker and they are issue tracker related. Please reference them in the corresponding page in this wiki.