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

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

以下のことが可能です。

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

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

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

On this page:

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

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

<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
注意

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

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

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

説明Jira Software 課題を特定のワークフロー状態に移行します。
構文<ignored text> ISSUE_KEY <ignored text> #<transition_name> <comment_string>
JRA-090 #close Fixed this today
注意

この例では、課題に対して課題のクローズ ワークフロー トランジションを実行し、コメント「Fixed this today」を課題に追加します。コメントは、#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 ユーザーのメールアドレスと一致する必要があります。

高度な例

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

構文

<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 でスマート コミットを有効にします。

  1. Jira 管理者権限を持つユーザーとして Jira にログインします。
  2. 画面の右上隅で、[管理] > [アプリケーション] を選択します。
  3. [統合] で [アプリケーション リンク] を選択します。
  4. 設定するアプリの横にある [アクション] > [スマート コミット] を選択します。
  5. スマートコミットを有効化するアカウントのチェックボックスを選択します。

FishEye

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

その後、Jira Software でスマート コミットを有効にします。

  1. Jira 管理者権限を持つユーザーとして Jira にログインします。
  2. 画面の右上隅で、[管理] > [アプリケーション] を選択します。
  3. [統合] で [アプリケーション リンク] を選択します。
  4. 設定するアプリの横にある [アクション] > [スマート コミット] を選択します。
  5. スマートコミットを有効化するアカウントのチェックボックスを選択します。

Crucible

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

その後、Jira Software でスマート コミットを有効にします。

  1. Jira 管理者権限を持つユーザーとして Jira にログインします。
  2. 画面の右上隅で、[管理] > [アプリケーション] を選択します。
  3. [統合] で [アプリケーション リンク] を選択します。
  4. 設定するアプリの横にある [アクション] > [スマート コミット] を選択します。
  5. スマートコミットを有効化するアカウントのチェックボックスを選択します。

Bitbucket Cloud、GitHub

最初に、Jira Software と Bitbucket または GitHub アカウントをリンクします。詳細については、「Bitbucket Cloud を Jira Software Server に接続する」および「GitHub アカウントをリンクする」を参照してください。 

新しいリポジトリでスマート コミットが有効であるかどうかを確認します。

  1. Jira 管理者権限を持つユーザーとして Jira にログインします。
  2. 画面の右上隅で、[管理] > [アプリケーション] を選択します。
  3. [統合] の下で、アカウントを選択します。
  4. アカウントの設定アイコン をクリックします。
  5. [新規リポジトリにスマート コミットを有効化] を選択します。

個々のリポジトリでスマートコミットを有効化または無効化する:

  1. Jira 管理者権限を持つユーザーとして Jira にログインします。
  2. 画面の右上隅で、[管理] > [アプリケーション] を選択します。
  3. [統合] の下で、アカウントを選択します。
  4. リポジトリの [スマート コミット] オプションを選択 (または、選択解除) します。 

注意

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

  • Git などの DVCS では、コミット データにユーザーのメール アドレスが含まれます。ユーザーは、自身のローカル システムでこのメール アドレスを設定します。スマート コミット機能では、このメール アドレスが Jira Software ユーザー ベース内のメール アドレスと正確に一致している必要があります。メール アドレスが Jira Software 内の複数のユーザーと一致する場合、または、ユーザーに要求されたアクションを実行する権限がない場合、スマート コミット アクションは失敗します。コミット自体は引き続き成功し、課題に表示されます。メール アドレスの不一致は、スマート コミットが期待どおりに動作しない場合の一般的な理由です。スマート コミットが失敗すると、Jira SoftwareJira Software ユーザーまたは DVCS ユーザー (Jira Software ユーザーが特定できない場合) のいずれかにメール通知を送信します。まれに、Jira Software がこれらのメール アドレスのいずれも保持していないと、スマート コミットは通知なしで失敗します。

  • ユーザーのリポジトリが Bitbucket Cloud または GitHub でホストされている場合、スマート コミットは Jira DVCS コネクター プラグインに依存します。このプラグインは Jira Software にバンドルされていますが、Jira 管理者は必要に応じて Jira 管理領域から直接インストールできます。これを実行するには、[アプリの管理] > [新しいアプリの検索] に移動します。「Marketplace アプリのインストール」を参照してください。
最終更新日: 2022 年 10 月 11 日

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

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