YouTrack サーバー 2024.2 ヘルプ

VCS コミットでのコマンドの適用

バージョン管理システムのコードリポジトリへの変更をコミットするときに、コマンドを課題に適用できます。YouTrack を開く必要すらありません。これらの変更を適用するには、特別な形式を使用して、コミットメッセージでコマンドを指定します。YouTrack でサポートされているコマンドの完全なリストについては、コマンドリファレンスを参照してください。

コミットメッセージに課題へのリンクを追加する方法をすでに見たかもしれません。これはさらに一歩進んだものです。課題とバージョン管理システム間を移動するのに役立つリンクを追加するだけでなく、IDE やリポジトリを移動せずに、YouTrack によって認識されるコマンドを適用できます。

この機能は、次の統合によってサポートされています。

ビルドサーバー統合の場合、この機能を使用できるかどうかは、プロジェクトでの統合の構成に基づいています。VCS 変更の処理設定で、コマンドを課題に適用 1 つ以上のマップされたプロジェクトへのオプションを有効にする必要があります。それ以外の場合、コマンドは YouTrack によって無視されます。これらの設定およびその他の構成オプションの詳細については、ビルドサーバー統合を参照してください。

VCS 変更作成者と YouTrack ユーザーの一致

VCS の変更をリンクしてコミットメッセージでコマンドを処理するには、YouTrack はコミットメッセージの作成者と一致するユーザーアカウントを見つける必要があります。コミットメッセージでコマンドが指定されている場合は、YouTrack でユーザーアカウントに付与されているアクセス許可に基づいて適用されます。ユーザーアカウントは、バージョン管理システムへの接続の種類に基づいてさまざまな方法で識別されます。

接続タイプ

説明

Kotlin DSL スニペット

YouTrack は、VCS に変更をコミットしたユーザーの TeamCity ユーザープロファイルに保存されているメールアドレスをチェックします。変更をコミットした TeamCity ユーザーを認識するには、VCS ユーザー名を TeamCity のユーザープロファイルに関連付ける必要があります。

VCS 統合

VCS 統合の場合、課題にコマンドを適用する機能は、VCS 統合設定のコミット者グループのメンバーであるユーザーに限られています。

  • 最初に、YouTrack はメールアドレスがコミット作成者のメールアドレスと一致するユーザーアカウントを検索します。見つかった場合は、このユーザーに代わってコマンドが実行されます。

  • コミット者グループ内のユーザーがそのようなメールアドレスを持っていない場合、YouTrack は名前で一致するものを見つけようとします。これは、統合 VCS によって提供された値を取得し、コミット者グループに属するユーザーの Hub アカウントに保存されている VCS のユーザー名のリストと比較します。

    • GitHub と GitLab は、名前として保存された値を提供します。

    • Bitbucket は、ニックネームとして保存された値を提供します。

コミットメッセージの作成者が YouTrack で見つからない場合、コマンドは適用されません。ユーザー名は、VCS の変更タブに赤いテキストで表示されます。警告ツールチップは、課題を修正するために使用できる情報を提供します。

VCS user not found

この課題を解決するためにユーザーができることは基本的に 2 つあります。

  • YouTrack と統合 VCS のアカウントに同じメールアドレスを使用してください。

  • 自分の Hub アカウントの VCS のユーザー名のリストに自分の名前(または Bitbucket のニックネーム)を追加します。

VCS によって変更が課題に適用されているかどうかを監視し、サーバー統合を構築することを可能にする特別なイベントカテゴリがあります。これらのイベントの購読オプションは、YouTrack プロファイル設定で利用できます。

command-related notifications

次のオプションが利用可能です:

通知イベント

説明

VCS とビルドサーバー統合によって適用された更新

VCS のコミットでコメントに入力されたコマンドの課題に変更が適用されたときに通知を送信します。これは、変更が統合ビルドサーバーまたは VCS によって処理されたかどうかを確認できます。

VCS とビルドサーバーの統合で処理されたコミットで失敗したコマンド

VCS コミットのコメントに入力されたコマンドが課題の更新に失敗したときに通知を送信します。これにより、VCS のユーザー名が YouTrack アカウントと正しく一致しないユーザーを特定したり、無効なコマンド構文を認識したりすることができます。

YouTrack プロファイルの通知設定を更新する方法については、一般的な通知スキームを参照してください。

コマンド構文

VCS またはビルドサーバー統合の設定には、課題のコメントに対するコミットを解析するオプションが含まれています。課題コメントに対するコミットを解析しますを有効にして、コマンドが別の課題のコメントにコピーされた後に新しい行で始まるメッセージテキストをコミットします。この機能はプロジェクトごとに個別に有効または無効にすることができ、デフォルトでは無効になっています。詳細については、VCS のコミットからコメントを生成するを参照してください。

課題にコマンドを適用するために使用するパターンは、この設定の影響を受けません。VCS のコミットメッセージからの課題にコマンドを適用するには、次の構文を使用します。

[commit message text] #issueID [command 1] [command 2] ... [command n] [issue comment text] ...

または

[commit message text] ^issueID [command 1] [command 2] ... [command n] [issue comment text] ...

コマンドや課題のコメントを含むコミットメッセージ全体が、アクティビティストリームの VCS 変更レコードの一部として表示されます。

commit message with command

メッセージテキストは次のコンポーネントに分類されます。

コンポーネント

説明

メッセージテキストをコミット

番号シンボルまたはキャレットの前にある文字列は、VCS 変更レコードに単純に追加されます。このテキストは、課題へのコメントとして適用されません。

コミットメッセージテキストは複数行を折り返し、空行を含めることができます。

コマンド

YouTrack は、番号シンボル(#)または脱字シンボル(^)を課題のフラグとして認識し、その後にコマンドが続きます。シャープシンボルまたはキャレットに続く文字は、issue ID と一致するように解析されます。issue ID の後に続く文字列は、現在行の最後までコマンドとして解析されます。コマンドの一部が次の行に折り返されると、コマンドは切り捨てられます。番号シンボルまたはキャレットで新しい行を開始することで、1 つ以上の課題に追加のコマンドを適用できます。

文字列に誤ったコマンドまたは属性参照が含まれていると、そのコマンドは適用されません。コマンド内のエラーは、VCS の変更タブでハイライトされます。

YouTrack でサポートされているコマンドの完全なリストについては、コマンドリファレンスを参照してください。

コメントテキストを発行する

統合に対して課題コメントに対するコミットを解析しますオプションが有効になっている場合、コマンドの後に新しい行として追加されたテキストは、コメントとして課題にコピーされます。コマンド間に複数行のテキストを追加できます。

プロジェクトでこのオプションが無効になっている場合、テキストは VCS 変更レコードの一部としてのみ表示されます。詳しくは、VCS のコミットからコメントを生成するを参照してください。

課題 ID

コミットメッセージ内に見つかったアーティファクト ID はすべてハイパーリンクに変換されます。これには、コマンドに対してフラグが立てられている課題、およびコミットメッセージまたは課題のコメントテキストに単純に記載されている課題が含まれます。

次の例は、課題 ID と概要がコミットメッセージテキストとして使用され、その後に課題の状態を準備完了に変更するコマンドが続くコミットメッセージを示しています。

RD-2677 article and formatting issues #RD-2677 Ready

複数の課題を更新する

括弧内の ID で課題をグループ化することにより、複数の課題にコマンドを適用することもできます。各課題に個別に同じコマンドを指定する必要はありません。例:

(#TST-12, #TST-324, #TST-433) Fixed Reviewed by john.d Revision ${revision}

この例のコマンドは 3 つの課題に適用されます。課題の状態は Fixed に設定され、レビューアーフィールドは john.d に設定されています。リビジョンフィールドの値は、${revision} プレースホルダーを使用して自動的に現在のリビジョンに設定されます。

次の例は、ボスなどの課題を更新する方法を示しています。1 つのコミットメッセージで、これらすべての変更が一度に適用されます。

  • 課題 TST-345 の場合、状態は Fixed に設定され、変更を確認した開発者がレビューアーフィールドに追加され、TeamCity からの改訂番号がリビジョンフィールドに追加され、コメントが課題に追加されます。

  • 課題 TST-423 および TST-348 の場合、状態は処理中に設定され、両方の課題にコメントが追加されます。

With this commit I've made the following progress: #TST-345 Fixed Reviewed by daria.s Revision ${revision} @William_Johnson I finally fixed this nasty bug!!! (#TST-423, #TST-348) In Progress I implemented the code to support this use case, but need to describe the steps for testing.

プレースホルダー

${revision} をコミットメッセージのプレースホルダーとして使用できます。プレースホルダーは、VCS コミットの実際のハッシュに置き換えられます。

TeamCity 統合は、ビルド属性用の追加のプレースホルダーをサポートしています。これらのプレースホルダーは、YouTrack でビルド番号が割り当てられているすべての課題に自動的に適用されるコマンドで使用されます。手動のコミットメッセージでこれらの追加のプレースホルダを使用することはできません。詳しくは、Kotlin DSL スニペットを参照してください。

関連ページ:

コマンドリファレンス

コマンドは基本的に、1 つ以上の課題に変更を一度に適用する一連の属性と値のペアです。多くの場合、属性をスキップして、適用する値を入力できます。YouTrack は、指定された値を使用する属性を検出し、コマンドの有効なオプションを提案します。コマンドの入力に使用する形式は、検索クエリで使用する構文と似ています。ただし、コロン、中括弧、シャープシンボルの使用規則はコマンドには適用されません。例: 自分に割り当てられ、タグ YouTrack モバイルに関連付けられている重要な課題を検索するには、次の検索ク...

VCS コミットのリンクの課題

ソフトウェア開発チームは、課題に応じてアプリケーションコードに変更を適用することがよくあります。これらの更新は通常、バージョン管理システム(VCS)に適用されます。コードを VCS リポジトリにコミットする場合、変更内容とその理由を説明するコミットメッセージを書き込むオプションがあります。YouTrack サーバーが VCS リポジトリと統合されている場合は、コミットメッセージまたはブランチ名で課題を参照できます。これらの参照は、リポジトリ、ビルド、YouTrack の課題へのコミットを指すリン...

Kotlin DSL スニペット

このページの指示に従って、1 つ以上の YouTrack プロジェクトと TeamCity のビルド構成の間の接続を確立します。YouTrack と TeamCity の統合により、両方のアプリケーションで便利な機能が有効になります。接続されているプロジェクトからビルド番号を取得し、解決された課題のビルド番号を格納するカスタムフィールドの値を自動的に更新します。YouTrack のビルド番号には、TeamCity のビルドに直接アクセスできるアイコンが付いています。コミットメッセージまたはブラン...

VCS 統合

YouTrack を使用すると、バージョン管理システムへの接続をセットアップできます。YouTrack は、GitHub、GitLab、Bitbucket との直接統合をサポートしています。YouTrack と、自己ホスト GitHub Enterprise、GitLab Community Edition(CE)、および GitLab Enterprise Edition(EE)、Bitbucket サーバー、Gogs、Gitea サーバー間の統合をセットアップすることもできます。新しい統合を...

ビルドサーバー統合

ビルドサーバーの統合は、開発チームが実行する重複した作業の量を削減できます。YouTrack とビルドサーバーの統合により、両方のアプリケーションで有用な機能が有効になります。YouTrack は、接続されたプロジェクトからビルド番号を取得します。これらのビルド番号を、1 つ以上の統合プロジェクトのカスタムフィールドの値のセットに追加できます。統合設定により、アセンブルされたビルドで参照される課題にビルド番号を自動的に割り当てることができます。ビルド番号が課題に自動的に割り当てられると、YouT...

VCS の変更の表示と編集

アクティビティストリームには、現在の課題に関連する VCS 変更のリストが表示されます。これらのイベントは、VCS の変更フィルターが有効な場合に表示されます。この情報は、プロジェクトがバージョン管理システムと統合されている場合にのみ利用できます。YouTrack は、バージョン管理システムと直接統合することも、TeamCity や Jenkins などのバージョン管理に接続されている別のアプリケーションを通じて統合することもできます。統合の表示設定が 1 つ以上のグループに制限されている場合、...