Smart Commit を使用する
When you manage your repositories in Bitbucket or GitHub, or use Fisheye to browse and search your repositories, you can process your Jira work items using special commands, called Smart Commits, in your commit messages.
以下のことが可能です。
作業項目にコメントする
作業項目に対する時間管理情報を記録する
transition work items to any status defined in the Jira space's workflow.
ソフトウェアのレビューに Crucible を使用する場合、ほかにもアクションを利用できます。Crucible ドキュメントの「スマート コミットを使用する」を参照してください。
A Smart Commit command must not span more than one line (i.e., you cannot use carriage returns in the command), but you can add multiple commands to the same line, as shown in the Advanced examples > Multiple commands on a single line example below.
スマートコミット コマンド
スマート コミット メッセージの基本的な構文は次のとおりです。
<ignored text> <WORK_ITEM_KEY> <ignored text> #<COMMAND> <optional COMMAND_ARGUMENTS>
作業項目キーとコマンドの間のテキストは無視されます。
スマート コミット メッセージでは次の 3 つのコマンドを使用できます。
commenttimetransition
コメント
説明 | Jira 作業項目にコメントを追加します。 |
|---|---|
構文 |
|
例 | JRA-34 #comment corrected indent work item |
注意 | The committer's email address must match the email address of a single Jira user with permission to comment on work items in that particular space. |
GitHub 使用時に関する詳細
The email address in Github must match the email address of a single Jira user with permission to comment on work items in that particular space.
In Github, do not check Keep my email addresses private for smart commits to work properly.
時間
説明 | Records time tracking information against an work item. |
|---|---|
構文 |
|
例 | JRA-34 #time 1w 2d 4h 30m Total work logged |
注意 | この例では、作業項目に対して 1 週間、2 日、4 時間と 30 分を記録し、作業項目の [作業ログ ] タブに「
|
ワークフローのトランジション
説明 | Jira 作業項目を特定のワークフロー状態に移行します。 |
|---|---|
構文 |
|
例 | JRA-090 #close #comment Fixed this today |
注意 | この例では、作業項目に対してクローズ作業項目ワークフロー トランジションを実行し、作業項目にコメント「 この構文にはいくつかの例外があります。
Smart Commit と併用可能なカスタムコマンドを確認するには、 Jira 作業項目と利用可能なワークフロー トランジションを確認します。
Smart Commit は、最初のスペースの前のトランジション名の部分のみを考慮します。したがって、 次のように、ワークフローに２つの有効なトランジションがある場合:
アクション
|
高度な例
単一の作業項目に対する複数のコマンド
構文 | <WORK_ITEM_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」を追加し、作業項目を解決します。 |
単一の作業項目に対して複数行にわたる複数のコマンド
構文 | <WORK_ITEM_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 行目の # この例では、以下のように設定すると、想定通りに動作します。 JRA-123 #comment Imagine that this is a really, and I mean really, long comment JRA-123 #time 2d 5h |
複数の作業項目に対する 1 つのコマンド
構文 | <WORK_ITEM_KEY1> <WORK_ITEM_KEY2> <WORK_ITEM_KEY3> #<COMMAND> <optional COMMAND_ARGUMENTS> etc |
|---|---|
コミット メッセージ | JRA-123 JRA-234 JRA-345 #resolve |
結果 | 作業項目 JRA-123、JRA-234 および JRA-345 を解決します。 複数の作業項目キーはホワイトスペースまたはコンマで区切る必要があります。 |
複数の作業項目に対する複数のコマンド
構文 | <WORK_ITEM_KEY1> <WORK_ITEM_KEY2> ... <WORK_ITEM_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 のインスタンスでスマート コミットを使用できるようにするのは簡単です。
ツール | 接続の手順 |
|---|---|
Bitbucket Cloud | まず、Jira と Bitbucket アカウントをリンクします。「Jira Cloud と Bitbucket Cloud の接続」を参照してください。 次に、Jira でスマート コミットを有効にします。「スマート コミットの有効化」を参照してください。 |
GitHub | まず、Jira と GitHub アカウントをリンクします。「Jira Cloud と GitHub の接続」を参照してください。 次に、Jira でスマート コミットを有効にします。「スマート コミットの有効化」を参照してください。 |
Bitbucket Data Center | Create an application link between Jira and Bitbucket Data Center. See Linking Bitbucket Data Center to Jira. 次に、Jira でスマート コミットを有効にします。「スマート コミットの有効化」を参照してください。 |
Fisheye | Create an application link between Jira and Fisheye. See Linking to another application. 次に、Jira でスマート コミットを有効にします。「スマート コミットの有効化」を参照してください。 |
Crucible | Create an application link between Jira and Crucible. See Linking to another application. 次に、Jira でスマート コミットを有効にします。「スマート コミットの有効化」を参照してください。 |
注意
スマート コミットは、既定の Jira 作業項目キー形式のみをサポートします。この形式では、2 つ以上の 大文字 にハイフンと作業項目番号が続きます (例: JRA-123)。
Git などの DVCS では、ユーザーのメール アドレスがコミット データに含まれます。ユーザーはローカル システムでこのメール アドレスを構成します。スマート コミットでは、このメール アドレスと Jira ユーザー ベースの 1 つのメール アドレスを完全に一致させる必要があります。メール アドレスが Jiraの複数のユーザーと一致する場合、またはリクエストした操作を実行する権限がユーザーにない場合、スマート コミット操作は失敗します。ただし、コミット自体は成功し、作業項目に表示されます。スマート コミットが期待どおりに機能しない一般的な理由は、メール アドレスの不一致です。スマート コミットが失敗すると、 Jira は Jira ユーザーまたは DVCS ユーザー ( Jira ユーザーが特定できない場合) にメール通知を送信します。稀なケースですが、Jira にどちらのメール アドレスもなく、スマート コミットが気付かないうちに失敗することがあります。
この内容はお役に立ちましたか?