The documentation in this space covers JIRA Studio-specific functions only.
Can't find documentation for a function in JIRA Studio? Please see this FAQ.
If you are working with code, you can action issues in JIRA Studio via Subversion commit messages. By using particular keywords in your commit message, you can log work, add comments or change the status of an issue. This makes it easy for you to maintain any issues that are related to the code you are changing.
The basic command line syntax for your commit comment is: <ISSUE_KEY> #<COMMAND> <optional COMMAND_PARAMETERS>
For example, if you include the following text in your commit message, JIRA Studio will record 2 days and 5 hours of work against issue JRA-123, when you perform your commit: JRA-123 #time 2d 5h
Please see the section on commit commands below for further information on the command line parameters.
Advanced command line syntax
If you wish to perform multiple actions on issues, you can create composite commands by combining keywords, as described below.
To perform multiple actions on a single issue: <ISSUE_KEY> #<COMMAND1> <optional COMMAND1_PARAMETERS> #<COMMAND2> <optional COMMAND2_PARAMETERS> #<COMMAND3> <optional COMMAND3_PARAMETERS> etc
For example, if you include the following text in your commit message, JIRA Studio will log 2 days and 5 hours of work against issue JRA-123, add the comment 'Task completed ahead of schedule' and resolve the issue, when you perform your commit: JRA-123 #time 2d 5h #comment Task completed ahead of schedule #resolve
To perform a single action on multiple issues: <ISSUE_KEY1> <ISSUE_KEY2> <ISSUE_KEY3> #<COMMAND> <optional COMMAND_PARAMETERS> etc
For example, if you include the following text in your commit message, JIRA Studio will resolve issues JRA-123, JRA-234 and JRA-345, when you perform your commit: JRA-123 JRA-234 JRA-345 #resolve
To perform multiple actions on multiple issues: <ISSUE_KEY1> <ISSUE_KEY2> <ISSUE_KEY3> #<COMMAND1> <optional COMMAND1_PARAMETERS> #<COMMAND2> <optional COMMAND2_PARAMETERS> #<COMMAND3> <optional COMMAND3_PARAMETERS> etc.
For example, if you include the following text in your commit message, JIRA Studio will log 2 days and 5 hours of work against issues JRA-123, JRA-234 and JRA-345, add the comment 'Task completed ahead of schedule' to all three issues, and resolve all three issues, when you perform your commit: JRA-123 JRA-234 JRA-345 #resolve #time 2d 5h #comment Task completed ahead of schedule
Please see the section on commit commands below for further information on the command line parameters.
The commit message syntax allows you to do even more complicated actions, than the examples described above. If you would like to view the formal syntax for the commit message definition, it is available on this FAQ
Commit Commands
Command
Command Parameters
Description
Example
#time
<n>w <n>d <n>h <n>m<work log comment> where <n> is a user-specified time period.
This command records time tracking information against an issue. Please note, time tracking must be enabled for your JIRA Studio instance to use this command. Please check with your JIRA Studio administrator, if you cannot record time tracking information against issues.
#time 1w 2d 4h 30m Total work logged — this command would record 1 week, 2 days, 4hours and 30 minutes against an issue, and add the comment 'Total work logged' in the Work Log tab of the issue.
#comment
<comment text>
This command records a comment against an issue.
#comment My comment. — this command would create the comment, "My comment", against the issue.
#<workflow command> e.g. #resolve
<resolution> <comment text> where <resolution> is an optional case-insensitive, resolution status, e.g. 'fixed', 'won't fix'.
This command transitions an issue to a particular workflow state. The default JIRA workflow transitions are mapped to commit commands with equivalent names:
Start Progress — #start
Stop Progress — #stop
Close Issue — #close
Resolve Issue — #resolve
Re-open Issue — #reopen
Please note, your JIRA Studio administrator may have set up a custom workflow or changed the default commit command for a particular transition. Please check with your JIRA Studio administrator for the commit commands available for you to use.
#close fixed Fixed the issue — this command would execute the 'Close Issue' workflow transition for an issue in the default JIRA workflow, setting the resolution status to fixed, and adding the comment 'Fixed the issue'. #start — this command would execute the 'Start Progress' workflow transition for an issue in the default JIRA workflow
Error Handling
If you have specified a commit command incorrectly, your code changes will still be committed to the repository. However, the associated JIRA issue action(s) will not be executed and you will be notified via email.
Possible commit command errors include:
Issue key not found
Workflow command not found, or not available for current status
No valid parameters are specified for a command that requires parameters
You do not have permissions to perform the specified action in JIRA, e.g. issue may be restricted by permissions
Add Comment