Smart Commit を使用する

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

以下のことが可能です。

  • 課題にコメントする

  • 課題の時間管理情報を記録する

  • Jira Software プロジェクトのワークフローに定義されているいずれかのステータスに課題を移行する

ソフトウェアのレビューに Crucible を使用する場合、ほかにもアクションを利用できます。Crucible ドキュメントの「Smart Commit を使用する」を参照してください。

スマート コミット コマンドは 1 行に収める必要があります (例えば、コマンドではキャリッジ リターンを使用できません) が、詳細な例で示されるように、同じ行に複数のコマンドを追加できます。1 行に複数のコマンドを入れる例は次を参照してください。

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

スマート コミット メッセージの基本的な構文は次のとおりです。

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

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

スマート コミット メッセージでは次の 3 つのコマンドを使用できます。

  • comment

  • time

  • transition

コメント

説明

コメントの追加

Jira Software

 

構文

<ignored text> <ISSUE_KEY> <ignored text> #comment <comment_string>

1 JRA-34 #comment corrected indent issue

注意

コミッターのメール アドレスが、その特定のプロジェクトで課題にコメントする権限を持つ単一の Jira Software ユーザーのメール アドレスと一致する必要があります。

GitHub 使用時に関する詳細

  • GitHub でのメールアドレスが、その特定のプロジェクトで課題にコメントする権限を持つ単一の Jira Software ユーザーのメールアドレスと一致する必要があります。

  • スマート コミットが正しく機能するためには、GitHub で [メールアドレスを非公開にする] のチェックをオフにします

時間

説明

課題に対する 時間管理情報を記録します。

構文

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

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

注意

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

  • wdh および m の値には、小数も使用できます。

  • コメントは、comment コマンドを使用しなくても自動的に追加されます。

  • コミット実施者のメール アドレスは、対象のプロジェクトでの課題へのコメント追加権限を持つ

    Jira Software

    ユーザー (課題で作業を記録する権限を持つユーザー)

  • システム管理者が

    Jira Software

    インスタンスでタイム トラッキングを有効化している必要があります。

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

説明

特定のワークフロー ステータスに

Jira Software

の課題をトランジションします。

構文

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

1 JRA-090 #close #comment Fixed this today

注意

この例では、課題に対して課題のクローズ ワークフロー トランジションを実行し、コメント「Fixed this today」を課題に追加します。 

この構文にはいくつかの例外があります。

  • Jira 管理者がコメントを必須フィールドに設定している場合、コマンドに #comment を追加しないでください。

  • その他のいずれかのフィールドが必須に設定されている場合、トランジション コマンドは通知なしで失敗します。

Smart Commit と併用可能なカスタムコマンドを確認するには、

Jira Software 課題と利用可能なワークフロー トランジションを確認します。

  1. プロジェクト内の課題を開きます。

  2. ワークフローの表示 (課題のステータスの近く) をクリックします。

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

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

  • Start Progress

  • Start Review

アクション #start を含むスマート コミットは 2 つのトランジションのいずれかを意味することになるため、曖昧であると見なされます。これら 2 つのトランジションの 1 つを指定するには、#start-review または #start-progress のいずれかを使用して、使用したいトランジションを完全修飾します。

  • 課題を #resolve コマンドで解決する場合、スマート コミットで解決状況フィールドを設定することはできません。

  • コミット実施者のメール アドレスは、対象のプロジェクトでの課題へのコメント追加権限を持つ

    Jira Software

    ユーザー (課題をトランジションする適切なプロジェクト権限を持つユーザー)

高度な例

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

構文

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

コミット メッセージ

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

結果

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

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

構文

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

コミット メッセージ

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

結果

コメント「Imagine that this is a really, and I」は追加されますが、残りのコメントは削除されます。2 行目の time コマンドに課題キーがないため、作業時間の 2 日と 5 時間は課題に記録されません。つまり、コミットメッセージの各行がスマートコミット構文に準拠している必要があります。

この例では、以下のように設定すると、想定通りに動作します。

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

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

構文

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

コミット メッセージ

1 JRA-123 JRA-234 JRA-345 #resolve

結果

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

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

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

構文

1 <ISSUE_KEY1> <ISSUE_KEY2> ... <ISSUE_KEYn> #<COMMAND_1> <optional COMMAND_1_ARGUMENTS> #<COMMAND_2> <optional COMMAND_2_ARGUMENTS> ... #<COMMAND_n> <optional COMMAND_n_ARGUMENTS>

コミット メッセージ

1 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 Cloud

まず、Jira Software と Bitbucket アカウントをリンクします。「Jira Cloud と Bitbucket Cloud の接続」を参照してください。

次に、Jira Software でスマート コミットを有効にします。「スマート コミットの有効化」を参照してください。

GitHub

まず、Jira Software と GitHub アカウントをリンクします。「Jira Cloud と GitHub の接続」を参照してください。

次に、Jira Software でスマート コミットを有効にします。「スマート コミットの有効化」を参照してください。

Bitbucket Data Center

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

次に、Jira Software でスマート コミットを有効にします。「スマート コミットの有効化」を参照してください。

Fisheye

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

次に、Jira Software でスマート コミットを有効にします。「スマート コミットの有効化」を参照してください。

Crucible

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

次に、Jira Software でスマート コミットを有効にします。「スマート コミットの有効化」を参照してください。

注意

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

  • Git などの DVCS のコミット データにはユーザーのメール アドレスが含まれています。ユーザーは自分のローカル システムでこのメール アドレスを構成します。スマート コミットでは、このメール アドレスと Jira Software ユーザー ベースのメール アドレスを完全に一致させる必要があります。メール アドレスが Jira Software 内の複数のユーザーと一致する場合、またはユーザーがリクエストした操作の権限を持たない場合、Smart Commit 操作は失敗します。ただし、コミットそのものは成功して課題に表示されます。スマート コミットが想定どおり動作しない理由として最もよくあるのが、メール アドレスの不一致です。Smart Commit が失敗すると、Jira Software は Jira Software ユーザーまたは DVCS ユーザー (Jira Software ユーザーが特定できない場合) にメール通知を送信します。稀に、Jira Software にいずれのメール アドレスも存在せず、Smart Commit が失敗しても通知されないことがあります。

その他のヘルプ