スマートコミットで課題を処理する
スマート コミット コマンド
スマートコミット メッセージの基本のコマンドライン構文は次のとおりです。
<ignored text> <ISSUE_KEY> <ignored text> #<COMMAND> <optional COMMAND_ARGUMENTS>
課題キーと Smart Commit コマンド間のテキストは無視されます。
コミットメッセージで使用できる Smart Commit コマンドは３つです。
コメント
| 説明 | Adds a comment to a Jira Software issue. |
|---|---|
| 構文 | <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 分を記録し、課題の [作業ログ] タブに「
|
ワークフローのトランジション
| 説明 | Transitions a Jira Software issue to a particular workflow state. |
|---|---|
| 構文 | <ignored text> ISSUE_KEY <ignored text> #<transition_name> <comment_string> |
| 例 | JRA-090 #close Fixed this today |
| 注意 | この例では、課題に対して課題のクローズ ワークフロー トランジションを実行し、コメント「 You can see the custom commands available for use with Smart Commits by visiting the Jira Software issue and seeing its available workflow transitions:
Smart Commit は、最初のスペースの前のトランジション名の部分のみを考慮します。したがって、 次のように、ワークフローに２つの有効なトランジションがある場合:
アクション
|
高度な例
単一の課題に対して複数行にわたる複数のコマンド
構文 | <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 のインスタンスでスマート コミットを使用できるようにするのは簡単です。
| ツール | 接続の説明 |
|---|---|
| Bitbucket Server | Create an application link between Jira Software and Bitbucket Server. See Linking Bitbucket Server to Jira. その後、Jira Software でスマート コミットを有効にします。
|
| FishEye | Jira Software と Fisheye 間のアプリケーション リンクを作成します。「別のアプリにリンクする」をご参照ください。 その後、Jira Software でスマート コミットを有効にします。
|
| Crucible | Jira Software と Crucible 間のアプリケーション リンクを作成します。「別のアプリにリンクする」をご参照ください。 その後、Jira Software でスマート コミットを有効にします。
|
| Bitbucket Cloud、GitHub | First, link your Jira Software and Bitbucket or GitHub accounts. See Connect Bitbucket Cloud to Jira Software Server and Linking GitHub accounts for details. 新しいリポジトリでスマート コミットが有効であるかどうかを確認します。
個々のリポジトリでスマートコミットを有効化または無効化する:
|
注意
スマート コミットは、既定の Jira Software 課題キー形式のみをサポートします。この形式では、2 つ以上の大文字に、ハイフンと課題番号が続きます (例: JRA-123)。
Git などの DVCS では、コミット データにユーザーのメール アドレスが含まれます。ユーザーは、自身のローカル システムでこのメール アドレスを設定します。スマート コミット機能では、このメール アドレスが Jira Software ユーザー ベース内のちょうど 1 つのメール アドレスと一致している必要があります。メール アドレスが Jira Software 内の複数のユーザーと一致する場合、または、ユーザーに要求されたアクションを実行する権限がない場合は、スマート コミット アクションが失敗します。コミット自体は引き続き成功し、課題に表示されます。メール アドレスの不一致は、スマート コミットが正常に動作しない場合の一般的な理由です。スマート コミットが失敗すると、Jira Software は Jira Software ユーザーまたは DVCS ユーザー (Jira Software ユーザーが特定できない場合) のいずれかにメール通知を送信します。まれに、Jira Software がこれらのメール アドレスのいずれも保持していないと、スマート コミットは通知なしで失敗します。
- ご利用のリポジトリが Bitbucket Cloud または GitHub でホストされている場合、スマート コミットは Jira DVCS コネクタ プラグインに依存します。このプラグインは Jira Software にバンドルされていますが、Jira 管理者であれば必要に応じて Jira 管理領域から直接インストールできます。これを実行するには、[アプリを管理] > [新しいアプリを検索] の順に移動します。「Marketplace アプリをインストールする」をご参照ください。