Movatterモバイル変換

[0]ホーム
URL:

Skip to main content
Bitbucket
Bitbucket Cloud

Documentation

Use Smart Commits

When you manage your project's repositories in Bitbucket or GitHub, or use Fisheye to browse and search your repositories, you can process yourJira work items using special commands, called Smart Commits, in your commit messages.

You can:

  • comment on work itemss

  • record time tracking information against work items

  • transition work items to any status defined in theJira project's workflow.

There are other actions available if you use Crucible for software reviews. See Using Smart Commits in the Crucible documentation.

A Smart Commit command must not span more than one line (i.e. you cannot use carriage returns in the command), but you can add multiple commands to the same line, as shown in the Advanced examples > Multiple commands on a single line example below.

Smart Commit commands

The basic syntax for a Smart Commit message is:

<ignored text> <WORK_ITEM_KEY> <ignored text> #<COMMAND> <optional COMMAND_ARGUMENTS>

Any text between the work item key and the command is ignored.

There are three commands you can use in your Smart Commit messages:

  • comment

  • time

  • transition

Comment

Description

Adds a comment to aJira work item.

Syntax

<ignored text> <WORK_ITEM_KEY> <ignored text> #comment <comment_string>

Example

JRA-34 #comment corrected indent work item

Note

The committer's email address must match the email address of a singleJira user with permission to comment on work items in that particular project

More information when using Github

  • The email address in Github must match the email address of a singleJira user with permission to comment on work items in that particular project

  • In Github, do not checkKeep my email addresses private for smart commits to work properly

Time

Description

Records time tracking information against an work item.

Syntax

<ignored text> <WORK_ITEM_KEY> <ignored text> #time <value>w <value>d <value>h <value>m <comment_string>

Example

JRA-34 #time 1w 2d 4h 30m Total work logged

Notes

This example records 1 week, 2 days, 4 hours and 30 minutes against the work item, and adds the comment 'Total work logged' in the Work Log tab of the work item.

  • The values forw,d,h andm can be decimal numbers.

  • The comment is added automatically without needing to use the #comment command.

  • The committer's email address must match the email address of a singleJira user with permission to log work on an work item.

  • Your system administrator must haveenabled time tracking on your

    Jira instance.

Workflow transitions

Description

Transitions aJira work item to a particular workflow state.

Syntax

<ignored text> <WORK_ITEM_KEY> <ignored text> #<transition_name> #comment <comment_string>

Example

JRA-090 #close #comment Fixed this today

Notes

This example executes the close work item workflow transition for the work item and adds the comment 'Fixed this today' to the work item. 

There are some exceptions to this syntax:

  • If your Jira admin has set comment as arequired field, you must not add #comment to the command

  • If any other fields have been set as required the transition command will silently fail.

You can see the custom commands available for use with Smart Commits by visiting the

Jira work item and looking at its available workflow transitions:

  1. Open a work item in the project.

  2. Select View Workflow (near the work item's Status).

The Smart Commit only considers the part of a transition name before the first space. So, for a transition name such as finish work, then specifying #finish is sufficient. You must use hyphens to replace spaces when ambiguity can arise over transition names, for example: #finish-work.

If a workflow has two valid transitions, such as:

  • Start Progress

  • Start Review

A Smart Commit with the action #start is ambiguous because it could mean either of the two transitions. To specify one of these two transitions, fully qualify the transition you want by using either #start-review or #start-progress.

  • When you resolve a work item with the #resolve command, you cannot set the Resolution field with Smart Commits.

  • The committer's email address must match the email address of a single

    Jira

    user with the appropriate project permissions to transition work items.

Advanced examples

Multiple commands on a single work item

Syntax

<WORK_ITEM_KEY> #<COMMAND_1> <optional COMMAND_1_ARGUMENTS> #<COMMAND_2> <optional COMMAND_2_ARGUMENTS> ... #<COMMAND_n> <optional COMMAND_n_ARGUMENTS>

Commit message

JRA-123 #time 2d 5h #comment Task completed ahead of schedule #resolve

Result

Logs 2 days and 5 hours of work against work item JRA-123, adds the comment 'Task completed ahead of schedule', and resolves the work item.

Multiple commands over multiple lines on a single work item

Syntax

<WORK_ITEM_KEY> #<COMMAND_1> <optional COMMAND_1_ARGUMENTS> #<COMMAND_2> <optional COMMAND_2_ARGUMENTS> ... #<COMMAND_n> <optional COMMAND_n_ARGUMENTS>

Commit message

JRA-123 #comment Imagine that this is a really, and I 
mean really, long comment #time 2d 5h

Result

Adds the comment 'Imagine that this is a really, and I', but drops the rest of the comment. The work time of 2 days and 5 hours isnot logged against the work item because there is no work item key for the #time command in the second line. That is, each line in the commit message must conform to the Smart Commit syntax.

This example would work as expected if set out as:

JRA-123 #comment Imagine that this is a really, and I mean really, long comment 
JRA-123 #time 2d 5h

A single command on multiple work items

Syntax

<WORK_ITEM_KEY1> <WORK_ITEM_KEY2> <WORK_ITEM_KEY3> #<COMMAND> <optional COMMAND_ARGUMENTS> etc

Commit message

JRA-123 JRA-234 JRA-345 #resolve

Result

Resolves work items JRA-123, JRA-234 and JRA-345.

Multiple work item keys must be separated by whitespace or commas.

Multiple commands on multiple work items

Syntax

<WORK_ITEM_KEY1> <WORK_ITEM_KEY2> ... <WORK_ITEM_KEYn> #<COMMAND_1> <optional COMMAND_1_ARGUMENTS> #<COMMAND_2> <optional COMMAND_2_ARGUMENTS> ... #<COMMAND_n> <optional COMMAND_n_ARGUMENTS>

Commit message

JRA-123 JRA-234 JRA-345 #resolve #time 2d 5h #comment Task completed ahead of schedule

Result

Logs 2 days and 5 hours of work against work items JRA-123, JRA-234 and JRA-345, adds the comment
'Task completed ahead of schedule' to all three work items, and resolves all three work items.

Multiple work item keys must be separated by whitespace or commas.

Get Smart Commits working

It's easy to get Smart Commits working for your instance ofJira:

Tool

Connection instructions

Bitbucket Cloud

First, link yourJira and Bitbucket accounts. SeeConnect Jira Cloud to Bitbucket Cloud.

Then, enable Smart Commits inJira. SeeEnable Smart Commits.

GitHub

First, link yourJira and GitHub accounts. SeeConnect Jira Cloud to GitHub.

Then, enable Smart Commits inJira. SeeEnable Smart Commits.

Bitbucket Data Center

Create an application link betweenJira and Bitbucket Data Center. SeeLinking Bitbucket Data Center to Jira.

Then, enable Smart Commits inJira. SeeEnable Smart Commits.

Fisheye

Create an application link betweenJira and Fisheye. SeeLinking to another application.

Then, enable Smart Commits inJira. SeeEnable Smart Commits.

Crucible

Create an application link betweenJira and Crucible. SeeLinking to another application.

Then, enable Smart Commits inJira. SeeEnable Smart Commits.

Notes

  • Smart Commits only support the defaultJira work item key format. This format is two or more uppercase letters, followed by a hyphen and the work item number, for example JRA-123. 

  • A DVCS such as Git includes a user's email address in the commit data. Users configure this email address in their local system. Smart Commits requires that this email address match exactly one email address in theJira user base. If the email address matches multiple users inJira, or the user does not have permissions for the requested action, the Smart Commit action will fail. The commit itself will succeed however, and will show on the work item. Mismatched email addresses is a common reason why Smart Commits fail to work as expected. If a Smart Commit fails,Jira sends an email notification to either theJira user, or to the DVCS user (if aJira user can't be identified). In rare cases,Jira doesn't have either of these email addresses, and the Smart Commit fails silently.

 

Was this helpful?

Still need help?

The Atlassian Community is here for you.
[8]ページ先頭
©2009-2025 Movatter.jp