スマートコミットで課題を処理する
スマート コミット コマンド
スマートコミット メッセージの基本のコマンドライン構文は次のとおりです。
<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 の活用
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:
|
| FishEye | Create an application link between Jira Software and Fisheye. See Linking to another application. Then, enable Smart Commits in Jira Software:
|
| Crucible | Create an application link between Jira Software and Crucible. See Linking to another application. Then, enable Smart Commits in 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. 新しいリポジトリでスマート コミットが有効であるかどうかを確認します。
個々のリポジトリでスマートコミットを有効化または無効化する:
|
注意
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 functionality requires that this email address matches exactly one email address in the Jira Software user base. If the email address matches 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 still succeed, 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.
- Smart commits relies on the Jira DVCS Connector Plugin when your repositories are hosted in Bitbucket Cloud or GitHub. The plugin is bundled with Jira Software, but if necessary, a Jira administrator can install it directly from within the Jira administration area. To do this, go to Manage apps > Find new apps. See Installing Marketplace apps.