スマート コミットを使用する

このページの内容

お困りですか?

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

コミュニティに質問

Smart Commits allow repository committers to process Jira Software 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 Data Center 4.2+ and Jira Software 7.1+.

On this page:

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

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

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

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

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

コメント

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

時間

説明 課題の 時間管理情報を記録します。
構文<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」というコメントを追加します。

  • wdh および 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 コマンドを使用しなくても自動的に追加されることに注意してください。

Smart Commit で利用できるカスタム コマンドを確認するには、Jira Software で課題にアクセスし、ワークフロー トランジションを表示します。

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

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

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

  • Start Progress
  • Start Review

アクション #start を含むスマート コミットは 2 つのトランジションのいずれかを意味することになるため、曖昧であると見なされます。これら 2 つのトランジションの 1 つを指定するには、#start-review または #start-progress のいずれかを使用して、使用したいトランジションを完全修飾します。

  • 課題を #resolve コマンドで解決する場合、スマート コミットで解決状況フィールドを設定することはできません。
  • トランジション中にコメントを追加したい場合、そのトランジションが関連する画面を持っている必要があります。
  • コミッターのメールアドレスは、課題をトランジションできる適切なプロジェクト権限を持つ単一の 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 4.2+ and Jira Software 7.1+.

To get Smart Commits working for Jira Software and Bitbucket:

  1. Create an application link between Jira Software and Bitbucket. See Linking Bitbucket 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 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 instance.

最終更新日 2024 年 9 月 24 日

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

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