Processing Jira Software issues with Smart Commit messages

Still need help?

The Atlassian Community is here for you.

コミュニティへの質問

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

以下のことが可能です。

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

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

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

このページの内容:

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

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

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

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

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

コメント

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

時間

説明 課題のタイム トラッキング情報を記録します。
構文 <無視されるテキスト> <ISSUE_KEY> <無視されるテキスト> #time <値>w <値>d <値>h <値>m <comment_string>
JRA-34 #time 1w 2d 4h 30m Total work logged
注意

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

  • wdh および m の値には、小数も使用できます。
  • コメントは、#comment コマンドを使用しなくても自動的に追加されます。
  • コミッターのメールアドレスが、課題に対する作業を記録する権限を持つ単一の Jira Software ユーザーのメールアドレスと一致する必要があります。
  • システム管理者があなたの Jira Software インスタンスの時間管理を有効にしていなければなりません。

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

説明 Jira Software 課題を特定のワークフロー状態に移行します。
構文 <無視されるテキスト> <ISSUE_KEY> <無視されるテキスト> #<transition_name> <comment_string>
JRA-090 #close Fixed this today
注意

この例では、課題に対して課題のクローズ ワークフロー トランジションを実行し、コメント「Fixed this today」を課題に追加します。コメントは、#comment コマンドを使用しなくても自動的に追加されることに注意してください。

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

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

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

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

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

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

  • 課題を #resolve コマンドで解決する場合、解決状況フィールドには Smart Commit を設定できません。
  • トランジション中にコメントを追加したい場合、そのトランジションが関連する画面を持っている必要があります。
  • コミッターのメールアドレスは、課題をトランジションできる適切なプロジェクト権限を持つ単一の Jira Software ユーザーのメールアドレスと一致する必要があります。

 

高度な例

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

構文

<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」を追加して
課題を解決します。

https://ja-stg.atlassian.com/jirasoftwarecloud/processing-issues-with-smart-commits-788960027.html

構文

<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

結果

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

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

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         

コミット メッセージ

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 Cloud

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

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

GitHub

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

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

Bitbucket Server

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

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

Fisheye

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

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

Crucible

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

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

注意

  • 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 が失敗しても通知されないことがあります。
  • ユーザーのリポジトリが Bitbucket Cloud または GitHub でホストされている場合、スマート コミットは Jira DVCS Connector Plugin に依存します。このプラグインは Jira Software にバンドルされていますが、Jira 管理者は必要に応じて Jira 管理領域から直接インストールできます。Jira で、アドオン > 新しいアドオン の検索に移動します。「アドオンのインストール」を参照してください。

最終更新日 2017 年 9 月 13 日

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

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

このセクションの項目

Powered by Confluence and Scroll Viewport.