スマート コミットを使用する
When you manage your project's repositories in Bitbucket or GitHub, or use Fisheye to browse and search your repositories, you can process your Jira Software issues using special commands, called Smart Commits, in your commit messages.
以下のことが可能です。
- 課題にコメントする
- 課題の時間管理情報を記録する
- transition issues to any status defined in the Jira Software project's workflow.
ソフトウェアのレビューに Crucible を使用する場合、ほかにもアクションを利用できます。Crucible ドキュメントの「Smart Commit を使用する」を参照してください。
スマート コミット コマンドは複数行にまたがることはできません（コマンドでキャリッジ リターンを使用することはできません）が、複数のコマンドを同じ行に追加することができます。以下の例を参照してください。
スマート コミット コマンド
スマート コミット メッセージの基本的な構文は次のとおりです。
<ignored text> <ISSUE_KEY> <ignored text> #<COMMAND> <optional COMMAND_ARGUMENTS>
課題キーとコマンドの間にあるテキストは無視されます。
スマート コミット メッセージでは 3 つのコマンドを使用できます。
コメント
| 説明 | コメントの追加 Jira Software |
|---|---|
| 構文 | <ignored text> <ISSUE_KEY> <ignored text> #comment <comment_string> |
| 例 | JRA-34 #comment corrected indent issue |
| 注意 |
|
時間
| 説明 | Records time tracking information against an 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 |
| 注意 |
| 説明 | 課題のタイム トラッキング情報を記録します。 |
|---|---|
| 構文 | <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 |
| 注意 |
ワークフローのトランジション
| 説明 | 特定のワークフロー ステータスに Jira Software の課題をトランジションします。 |
|---|---|
| 構文 | <ignored text> <ISSUE_KEY> <ignored text> #<transition_name> |
| 例 | JRA-090 #close #comment 本日修正 |
| 注意 | この例では、課題に対して課題のクローズ ワークフロー トランジションを実行し、コメント「 この構文にはいくつかの例外があります。
Smart Commit と併用可能なカスタムコマンドを確認するには、 Jira Software 課題にアクセスし、利用可能なワークフロー トランジションを確認します。
Smart Commit は、最初のスペースの前のトランジション名の部分のみを考慮します。したがって、 次のように、ワークフローに２つの有効なトランジションがある場合:
アクション
|
高度な例
単一の課題に複数のコマンド
構文 | <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_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 |
複数の課題に対して単一コマンドを使用
構文 | <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 の活用
It's easy to get Smart Commits working for your instance of Jira Software:
| ツール | 接続の説明 |
|---|---|
| Bitbucket Server | Create an application link between Jira Software and Bitbucket Server. See Linking Bitbucket Server to Jira. Then, enable Smart Commits in Jira Software. See Enabling DVCS Smart Commits. |
| Fisheye | Create an application link between Jira Software and Fisheye. See Linking to another application. Then, enable Smart Commits in Jira Software. See Enabling DVCS Smart Commits. |
| Crucible | Create an application link between Jira Software and Crucible. See Linking to another application. Then, enable Smart Commits in Jira Software. See Enabling DVCS Smart Commits. |
| Bitbucket Cloud | First, link your Jira Software and Bitbucket accounts. See Linking Bitbucket Cloud and GitHub accounts to Jira Software. Then, enable Smart Commits in Jira Software. See Enabling DVCS Smart Commits. |
| GitHub | First, link your Jira Software and GitHub accounts. See Linking Bitbucket Cloud and GitHub accounts to Jira Software. Then, enable Smart Commits in Jira Software. See Enabling DVCS Smart Commits. |
| ツール | 接続の説明 |
|---|---|
| Bitbucket Cloud | First, link your Jira Software and Bitbucket accounts. See Connect Jira Cloud to Bitbucket. Then, enable Smart Commits in Jira Software. See Enable Smart Commits. |
| GitHub | First, link your Jira Software and GitHub accounts. See Connect Jira Cloud to GitHub. Then, enable Smart Commits in Jira Software. See Enable Smart Commits. |
| Bitbucket Server | Create an application link between Jira Software and Bitbucket Server. See Linking Bitbucket Server to Jira. Then, enable Smart Commits in Jira Software. See Enable Smart Commits. |
| Fisheye | Create an application link between Jira Software and Fisheye. See Linking to another application. Then, enable Smart Commits in Jira Software. See Enable Smart Commits. |
| Crucible | Create an application link between Jira Software and Crucible. See Linking to another application. Then, enable Smart Commits in Jira Software. See Enable Smart Commits. |
注意
Smart Commits only support the default Jira Software issue key format. This format is two or more uppercase letters, followed by a hyphen and the issue number, for example JRA-123.
- A DVCS such as Git includes a user's email address in the commit data. Users configure this email address in their local system. Smart Commits requires that this email address match exactly one email address in the Jira Software user base. If the email address matches to multiple users in Jira Software, or the user does not have permissions for the requested action, the Smart Commit action will fail. The commit itself will succeed however, and will show on the issue. Mismatched email addresses is a common reason why Smart Commits fail to work as expected. If a Smart Commit fails, Jira Software sends an email notification to either the Jira Software user, or to the DVCS user (if a Jira Software user can't be identified). In rare cases, Jira Software doesn't have either of these email addresses, and the Smart Commit fails silently.