Commit Command

Version 2 by Steve Luo
on Jun 06, 2010 04:14.

<< Changes from 1 to 2
compared with
Version 3 by Steve Luo
on Jun 10, 2010 20:10.

Changes from 3 to 4 >>
Key
These lines were removed. This word was removed.
These lines were added. This word was added.

View page history


There are 7 changes. View first change.

 Commit command is used in commit message to update or progress issues. It has below syntax:
 {code}
 ACTION ISSUE_KEY [ISSUE_KEY ...] [--ATTRIBUTE1 VALUE1] [--ATTRIBUTE2 VALUE2]
 {code}
  
 For example, the command below is used in JIRA and will progress the issues TST-1, TST-2 and TST-3 with workflow transition 'Resolve Issue' and add comment 'something is updated' to them.
  For example, the command below means: actions 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 something is updated
  Fix TST-1, TST-2 and TST-3 --comment implemented a cool feature
 {code}
  
Here, the action is _Fix_, and issues are TST-1, TST-2, TST-3, the attribute is _comment_ which has a value _something is updated_.
  
 *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 comment \
 Second line comment \
 Third line comment
  Fix TST-1 --comment First line \
 Second line \
 Third line
 {code}
  
 *Command Action*
  
The action can be customized when you add a *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.
  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 Attribute*
  
 The attributes in a commit command are specified by the issue tracker. Please reference them in the appropriate page in this wiki.
  The attributes in a commit command are also issue tracker related. Please reference them in the corresponding page in this wiki.