スマート コミットの利用
スマート コミット コマンド
スマートコミット メッセージの基本のコマンドライン構文は次のとおりです。
<ignored text> <ISSUE_KEY> <ignored text> #<COMMAND> <optional COMMAND_ARGUMENTS>
課題キーと Smart Commit コマンド間のテキストは無視されます。
コミットメッセージで使用できる Smart Commit コマンドは３つです。
コメント
Description
Adds a comment to a JIRA Software issue.
構文
<ignored text> ISSUE_KEY <ignored text> #comment <comment_string>
例
JRA-34 #comment corrected indent issue
Notes
The committer's email address must match the email address of a single JIRA Software user with permission to comment on issues in that particular project.
時間
説明
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
注意
この例では、課題に対して 1 週間、2 日、4 時間と 30 分を記録し、課題の [作業ログ] タブに「Total work logged」というコメントを追加します。
w、d、hおよびmの値には小数も使用できます。- コミッターのメールアドレスが、課題に対する作業を記録する権限を持つ単一の JIRA Software ユーザーのメールアドレスと一致する必要があります。
- システム管理者があなたの JIRA Software インスタンスの時間管理を有効にしていなければなりません。
ワークフローのトランジション
説明
JIRA Software 課題を特定のワークフロー状態に移行します。
構文
<ignored text> ISSUE_KEY <ignored text> #<transition_name> <comment_string>
例
JRA-090 #close Fixed this today
注意
この例では、課題に対して課題のクローズ ワークフロー トランジションを実行し、コメント「Fixed this today」を課題に追加します。コメントは、#comment コマンドを使用しなくても自動的に追加されることに注意してください。
JIRA Software 課題にアクセスし、利用可能なワークフロートランジションを見ることで、Smart Commit と併用可能なカスタムコマンドを確認できます。
- プロジェクト内の課題を開きます。
- ワークフローの表示 (課題のステータスの近く) をクリックします。
Smart Commit は、最初のスペースの前のトランジション名の部分のみを考慮します。したがって、finish work などのトランジション名の場合、#finish と指定すれば十分です。トランジション名に曖昧さが含まれる場合、スペースの代わりにハイフンを使用する必要があります。たとえば、#finish-work などです。
次のように、ワークフローに２つの有効なトランジションがある場合:
Start ProgressStart Review
アクション #start を含むスマート コミットは 2 つのトランジションのいずれかを意味することになるため、曖昧であると見なされます。これら 2 つのトランジションの 1 つを指定するには、#start-review または #start-progress のいずれかを使用して、使用したいトランジションを完全修飾します。
- 課題を
#resolveコマンドで解決する場合、スマート コミットで解決状況フィールドを設定することはできません。 - トランジション中にコメントを追加したい場合、そのトランジションが関連する画面を持っている必要があります。
- コミッターのメールアドレスは、課題をトランジションできる適切なプロジェクト権限を持つ単一の JIRA Software ユーザーのメールアドレスと一致する必要があります。
Smart Commit commands for Crucible reviews
When creating a new review using a Smart Commit the default project objectives are added to the review, and since Fisheye/Crucible 2.10.2, the commit message is also copied to the review objectives.
Note that you cannot add arbitrary objectives to the review using a Smart Commit.
Create a review
| 説明 | Create a review in Crucible. |
|---|---|
| 構文 | <commit message> +review <project key> |
| 例 | Fix a bug +review CR-TEST |
| 注意 | The |
Add reviewers
| 説明 | Add reviewers when creating a new review in Crucible. |
|---|---|
| 構文 | <commit message> +review <project key> <reviewer_1> <reviewer_2>... <reviewer_n> |
| 例 | Fix a bug +review CR-TEST @jcage @skhan |
| 注意 | The command will create a new review in PROJ and add the users jcage and skhan to the review. The review will be automatically started if reviewers are specified. Note that you cannot add reviewers to existing reviews using Smart Commits. |
Update a review
| 説明 | Iteratively add new code changes to a review |
|---|---|
| 構文 | <commit message> +review <review key> |
| 例 | Implement rework on past work +review CR-TEST-123 |
| 注意 | Often, reviews require rework and changes in response to comments left by the team. When committing these changes, adding the review key will iteratively add these new changes to the review. 注意:
|
高度な例
単一の課題に複数のコマンド
構文 | <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 の活用
Your Fisheye administrator must have:
- Enabled Smart Commits in Fisheye. See Enabling Smart Commits.
Configured an application link between Fisheye/Crucible and Jira Software. See Linking to another application.
注意:
- Smart Commits only support the default Jira Software issue key format (that is, two or more uppercase letters, followed by a hyphen and the issue number, for example BAM-123).
- Smart Commits don't provide for field-level updates in Jira Software issues.
When using Smart Commits you can use linkers that create a hyperlink to the Jira Software issue. See Linkers for more information.
If there are any errors during the processing of Smart Commits, they will be logged to Fisheye's error console, as well as emailed to the actioning users. Speak to your Fisheye administrator about Configuring SMTP.
If the application link is configured as OAuth
If the application link to Jira Software is configured to use OAuth, the committing user must authenticate with Jira Software before any Smart Commit will work with Jira Software.