Bitbucket Server で Smart Commits を使用する

お困りですか?

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

コミュニティに質問

Smart Commits allow repository committers to process Jira Software Server issues using special commands in your commit messages.

以下のことが可能です。

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

A single Smart Commit command cannot span more than one line (you cannot use carriage returns in the commit message), but you can add multiple commands to the same line, or multiple commands on separate lines. See this example below.

Smart Commits work with Bitbucket Server 4.2+ and Jira Software Server 7.1+.

このページの内容:

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

Smart Commit メッセージでの基本的なコマンドライン構文は次のとおりです。

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

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

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

コメント

説明 JIRA Software 課題にコメントを追加する
構文 <ignored text> ISSUE_KEY <ignored text> #comment <comment_string>
JRA-34 #comment corrected indent issue
注意
  • コミッターのメールアドレスが、その特定のプロジェクトで課題にコメントする権限を持つ単一の JIRA Software ユーザーのメールアドレスと一致する必要があります。

時間

説明 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, 4hours 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. ワークフローの表示 (課題のステータスの近く) をクリックします。

The smart commit only considers the part of a transition name before the first space. So, for a transition name such as finish work, then specifying #finish is sufficient. You must use hyphens to replace spaces when ambiguity can arise over transition names, for example: #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 ユーザーのメールアドレスと一致する必要があります。

高度な例

単一の課題に対して複数行にわたる複数のコマンド

構文


<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

Result
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

Result
Logs 2 days and 5 hours of work against issue JRA-123, adds the comment 'Task completed ahead of schedule', and resolves the issue.

複数の課題に対して単一コマンドを使用

構文


<ISSUE_KEY1> <ISSUE_KEY2> <ISSUE_KEY3> #<COMMAND> <optional COMMAND_ARGUMENTS> etc 


コミット メッセージ

JRA-123 JRA-234 JRA-345 #resolve

Result
Resolves issues JRA-123, JRA-234 and JRA-345. Multiple issue keys must be separated by whitespace or commas.

複数の課題に対して複数のコマンドを使用

構文


<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

Result
Logs 2 days and 5 hours of work against issues JRA-123, JRA-234 and JRA-345, adds the comment 'Task completed ahead of schedule' to all three issues, and resolves all three issues. Multiple issue keys must be separated by whitespace or commas.


Smart Commit の活用

Smart Commits work with Bitbucket Server 4.2+ and Jira Software Server 7.1+.

To get Smart Commits working for Jira Software and Bitbucket Server:

  1. Create an application link between Jira Software and Bitbucket Server. See Linking Bitbucket Server with Jira.
  2. Enable smart commits in Jira Software. See Enabling DVCS Smart Commits.

Some limitations of Smart Commits:

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

  • Note that elevated access rights in Jira Software Server can result from the way that Git (and Mercurial) allow commits to be attributed to a user other than the user pushing a change to the repository. If this seems like a risk for your situation, then you should consider disabling Smart Commits on the Jira Software Server instance.

最終更新日 2018 年 9 月 17 日

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

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