Processing Jira Software issues with Smart Commit messages

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

以下のことが可能です。

  • 課題にコメントする
  • 課題の 時間管理情報を記録する
  • transition issues to any status defined in the Jira Software 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. See this example below.

このページの内容:

スマートコミット コマンド

The basic syntax for a Smart Commit message is:

<無視されるテキスト> <ISSUE_KEY> <無視されるテキスト> #<COMMAND> <optional COMMAND_ARGUMENTS>

Any text between the issue key and the command is ignored.

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

コメント

説明 Adds a comment to a Jira Software issue.
構文 <ignored text> <ISSUE_KEY> <ignored text> #comment <comment_string>
JRA-34 #comment corrected indent issue
注意
  • The committer's email address must match the email address of a single Jira Software user with permission to comment on issues in that particular project.

時間

説明 課題の 時間管理情報を記録します。
構文 <ignored text> <ISSUE_KEY> <ignored text> #time <value>w <value>d <value>h <value>m <comment_string>
JRA-34 #time 1w 2d 4h 30m Total work logged
注意

この例では、課題に対して 1 週間、2 日、4 時間と 30 分と記録し、課題のWork Logタブに「Total work logged」というコメントを追加します。

  • The values for w, d, h and m 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 single Jira Software user with permission to log work on an issue.
  • Your system administrator must have enabled time tracking on your Jira Software instance.

ワークフローのトランジション

説明 Transitions a Jira Software issue to a particular workflow state.
構文 <ignored text> <ISSUE_KEY> <ignored text> #<transition_name> <comment_string>
JRA-090 #close Fixed this today
注意

This example executes the close issue workflow transition for the issue and adds the comment 'Fixed this today' to the issue. Note that the comment is added automatically without needing to use the #comment command.

You can see the custom commands available for use with Smart Commits by visiting the Jira Software issue and looking at its available workflow transitions:

  1. プロジェクト内の課題を開きます。
  2. ワークフローの表示 (課題のステータスの近く) をクリックします。

Smart Commit は、最初のスペースの前のトランジション名の部分のみを考慮します。したがって、作業完了などのトランジション名の場合、#finish と指定すれば十分です。トランジション名について曖昧さが問題になりそうな場合、スペースの代わりにハイフンを使用する必要があります。たとえば、#finish-work などです。

次のように、ワークフローに2つの有効なトランジションがある場合:

  • 進行開始
  • レビューの開始

アクション #start を含む Smart Commit は2つのトランジションのいずれかを意味することになるため曖昧です。これら2つのトランジションの1つを指定するには、#start-review または#start-progress のいずれかを使用することで必要なトランジションを完全修飾します。

  • 課題を #resolve コマンドで解決する場合、解決状況フィールドには Smart Commit を設定できません。
  • トランジション中にコメントを追加したい場合、そのトランジションが関連する画面を持っている必要があります。
  • The committer's email address must match the email address of a single Jira Software user with the appropriate project permissions to transition issues.

 

高度な例

単一の課題に複数のコマンド

構文

<ISSUE_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

結果

課題 JRA-123に対して、2 日と 5 時間作業を記録し、コメント「Task completed ahead of schedule」を追加して
課題を解決します。

Multiple commands over multiple lines on a single issue

構文

<ISSUE_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

結果

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 is not logged against the issue because there is no issue 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

複数の課題に対して単一コマンドを使用

構文

<ISSUE_KEY1> <ISSUE_KEY2> <ISSUE_KEY3> #<COMMAND> <optional COMMAND_ARGUMENTS> etc         

Commit message

JRA-123 JRA-234 JRA-345 #resolve

結果

課題 JRA-123、JRA-234 および JRA-345 を解決。

複数の課題キーはホワイトスペースまたはコンマで区切る必要があります。

複数の課題に対して複数のコマンドを使用

構文

<ISSUE_KEY1> <ISSUE_KEY2> ... <ISSUE_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

結果

課題 JRA-123、JRA-234 および JRA-345に対して、2 日と 5 時間作業を記録し、コメントを追加します。
3つの課題すべてにコメント「Task completed ahead of schedule」を追加し、3つの課題すべてを解決します。

複数の課題キーはホワイトスペースまたはコンマで区切る必要があります。

Smart Commit の活用

It's easy to get Smart Commits working for your instance of Jira Software:

ツール 接続の説明
Bitbucket Cloud

First, link your Jira Software and Bitbucket accounts. See Connect Jira Cloud to Bitbucket Cloud.

Then, enable Smart Commits in Jira Software. See Enable Smart Commits.

GitHub

First, link your Jira Software and GitHub accounts. See Connect Jira Cloud to GitHub.

Then, enable Smart Commits in Jira Software. See Enable Smart Commits.

Bitbucket Server

Create an application link between Jira Software and Bitbucket Server. See Linking Bitbucket Server to Jira.

Then, enable Smart Commits in Jira Software. See Enable Smart Commits.

Fisheye

Create an application link between Jira Software and Fisheye. See Linking to another application.

Then, enable Smart Commits in Jira Software. See Enable Smart Commits.

Crucible

Create an application link between Jira Software and Crucible. See Linking to another application.

Then, enable Smart Commits in Jira Software. See Enable Smart Commits.

注意

  • Smart Commits only support the default Jira Software issue key format. This format is two or more uppercase letters, followed by a hyphen and the issue 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 the Jira Software user base. If the email address matches to multiple users in Jira Software, 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 issue. Mismatched email addresses is a common reason why Smart Commits fail to work as expected. If a Smart Commit fails, Jira Software sends an email notification to either the Jira Software user, or to the DVCS user (if a Jira Software user can't be identified). In rare cases, Jira Software doesn't have either of these email addresses, and the Smart Commit fails silently.
  • Smart Commits relies on the Jira DVCS Connector Plugin when your repositories are hosted in Bitbucket Cloud or GitHub. The plugin is bundled with Jira Software, but if necessary, a Jira administrator can install it directly from within the Jira administration area. In Jira, go to Add-ons > Find new Add-ons. See Installing add-ons.

最終更新日 2017 年 9 月 13 日

この翻訳に満足しましたか?

はい
いいえ
この記事についてのフィードバックを送信する

このセクションの項目

お探しの情報が見つかりませんか?

コミュニティへの質問

Powered by Confluence and Scroll Viewport.