スマートコミットで課題を処理する
スマート コミット コマンド
スマートコミット メッセージの基本のコマンドライン構文は次のとおりです。
<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 |
注意 |
|
時間
説明 | 課題の 時間管理情報を記録します。 |
---|---|
構文 | <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 分を記録し、課題の [作業ログ] タブに「
|
ワークフローのトランジション
説明 | Jira Software 課題を特定のワークフロー状態に移行します。 |
---|---|
構文 | <ignored text> ISSUE_KEY <ignored text> #<transition_name> <comment_string> |
例 | JRA-090 #close Fixed this today |
注意 | この例では、課題に対して課題のクローズ ワークフロー トランジションを実行し、コメント「 Smart Commit で利用できるカスタム コマンドを確認するには、Jira Software で課題にアクセスし、ワークフロー トランジションを表示します。
Smart Commit は、最初のスペースの前のトランジション名の部分のみを考慮します。したがって、 次のように、ワークフローに2つの有効なトランジションがある場合:
アクション
|
高度な例
単一の課題に対して複数行にわたる複数のコマンド
構文 | <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 |
結果 | Adds the comment 'This is a really, and I' (but drops the rest of the comment) and logs 2 days and 5 hours of work against issue JRA-123. |
単一の課題に複数のコマンド
構文 | <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 時間作業を記録し、コメントを追加します。 複数の課題キーはホワイトスペースまたはコンマで区切る必要があります。 |
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 アカウントをリンクさせます。「DVCS Smart Commit を有効にする」を参照してください。 その後、Jira Software で Smart Commit を有効化します。「DVCS Smart Commit を有効にする」を参照してください。 |
GitHub | まず、Jira Software と GitHub アカウントをリンクさせます。「DVCS Smart Commit を有効にする」を参照してください。 その後、Jira Software で Smart Commit を有効化します。「DVCS 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 が失敗しても通知されないことがあります。
- ユーザーのリポジトリが Bitbucket Cloud または GitHub でホストされている場合、Smart Commit は Jira DVCS Connector プラグインに依存します。このプラグインは Jira Software にバンドルされていますが、Jira 管理者は必要に応じて Jira 管理領域から直接インストールできます。[アプリの管理] > [新しいアプリの検索] に移動します。「Marketplace アプリのインストール」を参照してください。