Smart Commit を使用する

お困りですか?

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

コミュニティに質問

Bitbucket または GitHub でプロジェクトのリポジトリを管理する場合、または FishEye を使用してリポジトリの参照や検索を行う場合、 コミットメッセージで Smart Commit と呼ばれる特別なコマンドを使用して Jira Software の課題を処理できます。

以下のことが可能です。

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

ソフトウェアのレビューに Crucible を使用する場合、ほかにもアクションを利用できます。Crucible ドキュメントの「Smart Commit を使用する」を参照してください。

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

このページの内容:

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

スマート コミット メッセージの基本的な構文は次のとおりです。

<無視されるテキスト> <ISSUE_KEY> <無視されるテキスト> #<COMMAND> <optional COMMAND_ARGUMENTS>

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

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

コメント

説明
Adds a comment to a

Jira Software

issue.
構文 <無視されるテキスト> <ISSUE_KEY> <無視されるテキスト> #comment <comment_string>
JRA-34 #comment corrected indent issue
注意
  • 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.

時間

説明 課題のタイム トラッキング情報を記録します。
構文 <無視されるテキスト> <ISSUE_KEY> <無視されるテキスト> #time <値>w <値>d <値>h <値>m <comment_string>
JRA-34 #time 1w 2d 4h 30m Total work logged
注意

この例では、課題に対して 1 週間、2 日、4 時間と 30 分と記録し、課題のWork Logタブに「Total work logged」というコメントを追加します。

  • wdh および m の値には、小数も使用できます。
  • コメントは、#comment コマンドを使用しなくても自動的に追加されます。
  • The committer's email address must match the email address of a single

    Jira Software

    user with permission to log work on an issue.
  • Your system administrator must have enabled time tracking on your

    Jira Software

    instance.

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

説明
Transitions a

Jira Software

issue to a particular workflow state.
構文 <ignored text> <ISSUE_KEY> <ignored text> #<transition_name> #comment <comment_string>
JRA-090 #close #comment Fixed this today
注意

この例は、課題に対して課題のクローズワークフロー トランジションを実行し、コメント「Fixed this today」を課題に追加します。 

There are some exceptions to this syntax:

  • If your Jira admin has set comment as a required field, you must not add #comment to the command
  • If any other fields have been set as required the transition command will silently fail.

You can see the custom commands available for use with Smart Commits by visiting the

Jira Software

issue and looking at its available workflow transitions:

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

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

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

  • Start Progress
  • Start Review

アクション #start を含む Smart Commit は 2 つのトランジションのいずれかを意味することになるため曖昧です。これら 2 つのトランジションの 1 つを指定するには、#start-review または#start-progress のいずれかを使用することで必要なトランジションを完全修飾します。

  • 課題を #resolve コマンドで解決する場合、解決状況フィールドには Smart Commit を設定できません。
  • The committer's email address must match the email address of a single

    Jira Software

    user with the appropriate project permissions to transition issues.


高度な例

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

構文

<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 行目の #time コマンドに課題キーがないため、作業時間 2 日と 5 時間は課題に記録されません。つまり、コミット メッセージの各行は、スマート コミット構文に準拠する必要があります。

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

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 の活用

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

ツール 接続の説明
Bitbucket Cloud

First, link your Jira Software and Bitbucket accounts. See Connect Jira Cloud to Bitbucket Cloud.

Then, enable Smart Commits in Jira Software. See Enable Smart Commits.

GitHub

まず、Jira Software と GitHub アカウントをリンクします。「Jira Cloud を GitHub に接続する」を参照してください

Then, enable Smart Commits in Jira Software. See Enable Smart Commits.

Bitbucket Server

Create an application link between Jira Software and Bitbucket Server. See Linking Bitbucket Server to Jira.

Then, enable Smart Commits in Jira Software. See Enable Smart Commits.

Fisheye

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

Then, enable Smart Commits in Jira Software. See Enable Smart Commits.

Crucible

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

Then, enable Smart Commits in Jira Software. See Enable Smart Commits.

注意

  • Smart Commits は、既定の Jira Software 課題キー形式のみをサポートします。この形式では、2つ以上の大文字の後にハイフンと課題番号が続きます (例: 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 succeed however, 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.

最終更新日 2018 年 7 月 20 日

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

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