スマートコミットで課題を処理する

Bitbucket または GitHub でプロジェクトのリポジトリを管理する場合、または FishEye を使用してリポジトリの参照や検索を行う場合、 コミットメッセージで Smart Commit と呼ばれる特別なコマンドを使用して JIRA Software の課題を処理できます。

以下のことが可能です。

  • 課題にコメントする
  • 課題の 時間管理情報を記録する
  • JIRA Software プロジェクトのワークフローに定義されているいずれかのステータスに課題を移行する

ソフトウェアのレビューに Crucible を使用する場合、利用可能な他のコマンドがあります。Crucible ドキュメントの「Smart Commit を使用する」を参照してください。

単一の スマートコミット コマンドは複数行にまたがることはできません (つまり、コミットメッセージでキャリッジリターンを使用できません) が、同じ行に複数のコマンドを追加するか、別々の行に複数のコマンドを追加できます。以下のこの例を参照してください。

このページの内容:

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

スマートコミット メッセージの基本のコマンドライン構文は次のとおりです。

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

課題キーと Smart Commit コマンド間のテキストは無視されます。

コミットメッセージで使用できる Smart Commit コマンドは3つです。

コメント

説明 JIRA Software 課題にコメントを追加する
構文 <ignored text> ISSUE_KEY <ignored text> #comment <comment_string>
JRA-34 #comment corrected indent issue
注意
  • コミッターのメールアドレスが、その特定のプロジェクトで課題にコメントする権限を持つ単一の JIRA Software ユーザーのメールアドレスと一致する必要があります。

時間

説明 課題の 時間管理情報を記録します。
構文 <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
注意

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

  • Each value for w, d, h and m can be a decimal number.
  • コミッターのメールアドレスが、課題に対する作業を記録する権限を持つ単一の JIRA Software ユーザーのメールアドレスと一致する必要があります。
  • システム管理者があなたの JIRA Software インスタンスの時間管理を有効にしていなければなりません。

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

説明 JIRA Software 課題を特定のワークフロー状態に移行します。
構文 <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.

JIRA Software 課題にアクセスし、利用可能なワークフロートランジションを見ることで、Smart Commit と併用可能なカスタムコマンドを確認できます。

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

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

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

  • 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 an issue with the #resolve command, you cannot set the Resolution field with Smart Commits.
  • トランジション中にコメントを追加したい場合、そのトランジションが関連する画面を持っている必要があります。
  • コミッターのメールアドレスは、課題をトランジションできる適切なプロジェクト権限を持つ単一の JIRA Software ユーザーのメールアドレスと一致する必要があります。

 

高度な例

単一の課題に対して複数行にわたる複数のコマンド

構文

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

コミット メッセージ

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

結果

課題 JRA-123 に対して「This is a really, and I」というコメントを追加し (しかし、残りのコメントが脱落)、作業を 2 日と 5 時間記録します。

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

構文

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

コミット メッセージ

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

結果

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

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

構文

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

コミット メッセージ

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>

コミット メッセージ

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 の活用

JIRA Software のインスタンスで Smart Commit を使用できるようにするのは簡単です。

ツール 接続の説明
Bitbucket Server

JIRA Software と Bitbucket Server 間のアプリケーション リンクを作成します。Bitbucket Server を JIRA にリンクする」を参照してください。

次に、Jira Software で Smart Commitを有効にしますDVCS Smart Commit の有効化」を参照してください

FishEye

JIRA Software と FishEye 間のアプリケーション リンクを作成します。別のアプリケーションにリンクする を参照してください

次に、Jira Software で Smart Commitを有効にしますDVCS Smart Commit の有効化」を参照してください

Crucible

JIRA Software と Crucible 間のアプリケーションリンクを作成します。別のアプリケーションにリンクする」を参照してください。

次に、Jira Software で Smart Commitを有効にしますDVCS Smart Commit の有効化」を参照してください

Bitbucket Cloud

最初に、JIRA Software と Bitbucket のアカウントをリンクします。「Bitbucket Cloud と GitHub のアカウントを JIRA Software と連携させる」を参照してください。

次に、Jira Software で Smart Commit を有効にします。DVCS Smart Commit の有効化」を参照してください

GitHub

最初に、JIRA Software と GitHub のアカウントをリンクします。「Bitbucket Cloud と GitHub のアカウントを JIRA Software と連携させる」を参照してください。

次に、Jira Softwareで Smart Commit を有効にします。「Smart Commit の有効化」を参照してください。

注意

  • Smart Commits は、既定の JIRA Software 課題キー形式のみをサポートします。この形式では、2つ以上の大文字の後にハイフンと課題番号が続きます (例: JRA-123)。 

  • Git などの DVCS にはユーザーのメールアドレスがコミットデータに含まれます。ユーザーは、ローカルシステムでこのメールアドレスを設定します。Smart Commit では、このメールアドレスが JIRA Software ユーザーベース内の1つのメールアドレスと正確に 一致する必要があります。このメールアドレスが JIRA Software 内の複数のユーザーと一致する場合、またはユーザーがリクエストした操作の権限を持たない場合、Smart Commit 操作は失敗します。しかし、コミット自体は成功し、課題に表示されます。メールアドレスの不一致は、Smart Commit が期待どおりに機能しない一般的な理由です。Smart Commit が失敗すると、JIRA Software はメール通知を JIRA Software ユーザーまたは DVCS ユーザー (JIRA Software ユーザーが特定できない場合) のいずれかに送信します。稀なケースでは、JIRA Software にこれらのいずれのメールアドレスも存在しないため、Smart Commit が失敗しても通知されないことがあります。
  • Smart Commit は、ユーザーのリポジトリが Bitbucket Cloud または GitHub でホストされている場合、JIRA DVCS Connector Pluginに依存します。このプラインは、JIRA Software にバンドルされていますが、必要に応じて JIRA 管理者は JIRA 管理領域から直接インストールできます。アドオン > 新しいアドオンを検索するに進みます。「アドオンのインストール」を参照してください。
最終更新日 2016 年 8 月 16 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.