スマートコミットで課題を処理する

When you manage your project's repositories in Bitbucket or GitHub or use Fisheye to browse and search your repositories, you can process your Jira Software issues using special commands, called Smart Commits, in your commit messages.

以下のことが可能です。

  • 課題にコメントする
  • 課題の時間管理情報を記録する
  • Jira Software プロジェクトのワークフローに定義されているいずれかのステータスに課題をトランジションする

ソフトウェアのレビューに Crucible を使用する場合、利用可能な他のコマンドがあります。Crucible ドキュメントの「Smart Commit を使用する」を参照してください。

単一の スマートコミット コマンドは複数行にまたがることはできません (つまり、コミットメッセージでキャリッジリターンを使用できません) が、同じ行に複数のコマンドを追加するか、別々の行に複数のコマンドを追加できます。以下のこの例を参照してください。

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

結果

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

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

Smart Commit の活用

Jira Software のインスタンスで Smart Commit を使用できるようにするのは簡単です。

ツール接続の説明
Bitbucket Server

Jira Software と Bitbucket Server 間のアプリケーション リンクを作成します。「Bitbucket Server を Jira にリンクする」を参照してください

Then, enable Smart Commits in Jira Software: 

  1. Jira 管理者権限を持つユーザーとして Jira にログインします。
  2. In the upper-right corner of the screen, select Administration  > Applications.
  3. Under Integrations, select Application links.
  4. Next to the application you want to configure, select Actions > Smart commits.
  5. スマート コミットを有効化するアカウントのチェックボックスを選択します。

FishEye

JIRA Software と FishEye 間のアプリケーション リンクを作成します。「別のアプリケーションにリンクするを参照してください

その後、Jira Software でスマート コミットを有効にします。

  1. Jira 管理者権限を持つユーザーとして Jira にログインします。
  2. In the upper-right corner of the screen, select Administration  > Applications.
  3. Under Integrations, select Application links.
  4. Next to the application you want to configure, select Actions > Smart commits.
  5. スマート コミットを有効化するアカウントのチェックボックスを選択します。

Crucible

Jira Software と Crucible 間のアプリケーションリンクを作成します。別のアプリケーションにリンクする」を参照してください。

Then, enable Smart Commits in Jira Software: 

  1. Jira 管理者権限を持つユーザーとして Jira にログインします。
  2. In the upper-right corner of the screen, select Administration  > Applications.
  3. Under Integrations, select Application links.
  4. Next to the application you want to configure, select Actions > Smart commits.
  5. スマート コミットを有効化するアカウントのチェックボックスを選択します。

Bitbucket Cloud,  GitHub

First, link your Jira Software and Bitbucket accounts. See Bitbucket or GitHub accounts. See Connect Bitbucket Cloud to Jira Software Server and Linking GitHub accounts for details. 

新しいリポジトリでスマート コミットが有効であるかどうかを確認します。

  1. Jira 管理者権限を持つユーザーとして Jira にログインします。
  2. In the upper-right corner of the screen, select Administration  > Applications.
  3. Under Integrations, select  accounts.
  4. Click the settings icon for the account.
  5. Select Enable Smart Commits on new repositories.

個々のリポジトリでスマートコミットを有効化または無効化する:

  1. Jira 管理者権限を持つユーザーとして Jira にログインします。
  2. In the upper-right corner of the screen, select Administration  > Applications.
  3. Under Integrations, select  accounts.
  4. Select (or deselect) the Smart commits option for a repository. 

注意

  • 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 numbe. 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 requires that this email address match exactly one email address in the Jira Software user base. If the email address matches to 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.
最終更新日: 2022 年 10 月 11 日

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

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