Using Smart Commits

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

Smart Commits allow repository committers to perform actions such as transitioning Jira Software issues or creating Crucible code reviews by embedding specific commands into their commit messages.

以下のことが可能です。

  • 課題にコメントする
  • 課題の 時間管理情報を記録する
  • transition issues to any status defined in the Jira Software project's workflow.

There are other actions available if you use Crucible. See below for more information.

Each Smart Commit message must not span more than one line (i.e. you cannot use a carriage return in the command), but you can add multiple commands to the same line. See this example below.

 

スマートコミット コマンド

スマートコミット メッセージの基本のコマンドライン構文は次のとおりです。

<ignored text> <ISSUE_KEY> <ignored text> #<COMMAND> <optional COMMAND_ARGUMENTS>

課題キーと Smart Commit コマンド間のテキストは無視されます。

コミットメッセージで使用できる Smart Commit コマンドは3つです。

コメント

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

注意

This example records 1 week, 2 days, 4 hours and 30 minutes against the issue, and adds the comment 'Total work logged' in the Work Log tab of the issue.

  • Each value for w, d, h and m can be a decimal number.
  • コミッターのメールアドレスが、課題に対する作業を記録する権限を持つ単一の JIRA Software ユーザーのメールアドレスと一致する必要があります。
  • システム管理者があなたの JIRA Software インスタンスの時間管理を有効にしていなければなりません。

ワークフローのトランジション

説明

JIRA Software 課題を特定のワークフロー状態に移行します。

構文

<ignored text> ISSUE_KEY <ignored text> #<transition_name> <comment_string>

 

JRA-090 #close Fixed this today

注意

This example executes the close issue workflow transition for the issue and adds the comment 'Fixed this today' to the issue. Note that the comment is added automatically without needing to use the #comment command.

JIRA Software 課題にアクセスし、利用可能なワークフロートランジションを見ることで、Smart Commit と併用可能なカスタムコマンドを確認できます。

  1. プロジェクト内の課題を開きます。
  2. ワークフローの表示 (課題のステータスの近く) をクリックします。

Smart Commit は、最初のスペースの前のトランジション名の部分のみを考慮します。したがって、finish work などのトランジション名の場合、#finish と指定すれば十分です。トランジション名に曖昧さが含まれる場合、スペースの代わりにハイフンを使用する必要があります。たとえば、#finish-work などです。

次のように、ワークフローに2つの有効なトランジションがある場合:

  • Start Progress
  • Start Review

A Smart Commit with the action #start is ambiguous because it could mean either of the two transitions. To specify one of these two transitions, fully qualify the transition you want by using either #start-review or #start-progress.

  • When you resolve an issue with the #resolve command, you cannot set the Resolution field with Smart Commits.
  • トランジション中にコメントを追加したい場合、そのトランジションが関連する画面を持っている必要があります。
  • コミッターのメールアドレスは、課題をトランジションできる適切なプロジェクト権限を持つ単一の 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 +review  command creates a new review in the project CR-TEST with the content of the changeset. The review will be in a draft state unless the project has default reviewers or reviewers are explicitly mentioned. If you only have one project in Crucible, or a repository is a project's default repository, it is not necessary to mention the project key.

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.

注意:

  • Each commit command in the Smart Commit must not span more than one line (i.e. you cannot use carriage returns). However, you can use multiple commands in the same commit message, and these can be on the same line.
  • Creating a review in Crucible using a Smart Commit requires that the author of the changeset has already been mapped to a Crucible username. See 'Author mapping' on Changing your user profile.

高度な例

単一の課題に複数のコマンド

構文

<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

結果

Adds the comment 'Imagine that this is a really, and I', but drops the rest of the comment. The work time of 2 days and 5 hours is not logged against the issue because there is no issue key for the #time command in the second line. That is, each line in the commit message must conform to the Smart Commit syntax.

この例では、以下のように設定すると、想定通りに動作します。

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 時間作業を記録し、コメントを追加します。
3つの課題すべてにコメント「Task completed ahead of schedule」を追加し、3つの課題すべてを解決します。

複数の課題キーはホワイトスペースまたはコンマで区切る必要があります。

Smart Commit の活用

Your Fisheye administrator must have:

注意:

  • 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.

Click to see how to authenticate with Jira Software...
  1. Create a test review in Fisheye.
  2. Log in as the committing user.
  3. Open the review and click Edit Details.
  4. Enter a Jira Software issue key for 'Linked Issue' and click Link. You'll be prompted to authenticate.
  5. Do this for every committing user (there's no need to create a new review, just link the review to any Jira Software issue).
最終更新日: 2018 年 9 月 25 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.