YouTrack サーバー 2024.2 ヘルプ

Jenkins 統合

このページの指示に従って、1 つ以上の YouTrack プロジェクトと Jenkins のプロジェクト間の接続を確立します。YouTrack と Jenkins の統合により、両方のアプリケーションで便利な機能が可能になります。

  • 接続されたプロジェクトからビルド番号をプルし、ビルド番号を格納するカスタムフィールドの値を自動的に更新します。

  • コミットメッセージまたはブランチ名で参照される課題に VCS 変更レコードを追加します。YouTrack の課題における VCS の変更の詳細については、VCS の変更の表示と編集を参照してください。

  • Jenkins がコミットを含むビルドをアセンブルするときにコミットメッセージ内の issue にコマンドを適用します。コミットメッセージ内のコマンドをフォーマットする方法については、VCS コミットでのコマンドの適用を参照してください。

前提条件

始める前に、以下の要件を確認してください。

  • バージョン 1.651.3 (1.x(ブランチ)または 2.15 (2.x(ブランチ)以降を実行する Jenkins インストールがあります。

  • Jenkins アカウントには、YouTrack のプロジェクトにリンクするプロジェクトを含むビューの読み取りアクセス権があります。

  • Jenkins と統合する YouTrack プロジェクトでは、ビルドまたはバージョンとして値を保存するカスタムフィールドを使用します。デフォルトのカスタムフィールドビルドで修正またはビルドまたはバージョンを保存するその他のカスタムフィールドを使用できます。

    ビルド番号を課題に追加したくない場合は、YouTrack のカスタムフィールドにビルド番号をマッピングせずに統合を有効にできます。この場合、開発者は引き続き統合に関する VCS の変更を処理するためのルールに基づいて、VCS コミットメッセージに課題についてメンションし、コマンドを適用できます。

  • リンクされたリポジトリ内の VCS ユーザー名を YouTrack のユーザーアカウントにマッピングするには、Jenkins 内のプロジェクトが変更ログ内のコミット作成者を使用するように設定されている必要があります。この設定を見つけるには、次のナビゲーションパスを使用します。「プロジェクト」>「構成」>「ソースコード管理」>「追加の動作」>「変更ログで作成者をコミット」を使用

  • 課題ビューに表示されている VCS の変更から差分へのリンクを有効にするには、Jenkins に最後の変更(英語)プラグインをインストールする必要があります。

Jenkins サーバーに接続する

統合を有効にするには、1 台以上の Jenkins サーバーに接続する必要があります。この操作は、プロジェクト管理者がプロジェクトごとに実行することもできます。詳しくは、Jenkins と統合するを参照してください。

管理者として、YouTrack 内の任意のプロジェクトに対して Jenkins 統合を有効にすることができます。

Jenkins サーバーに接続するには:

  1. 管理メニューから、統合> サーバー統合の構築を選択します。

  2. ビルドサーバー統合設定ページで、ツールバーの新しいビルドサーバーの統合リンクをクリックします。

    • サイドバーに新規ビルドサーバーダイアログが開きます。

      Settings for adding an integration with a new Jenkins server.
  3. 以下の設定に値を入力します。

    設定

    説明

    URL

    Jenkins サーバーの URL を入力してください。

    タイプ

    Jenkins を選択します。

    ユーザー名

    Jenkins ユーザーアカウントのユーザー名を入力してください。

    パスワード

    Jenkins ユーザーアカウントのパスワードを入力してください。

  4. 拡張設定セクションを展開して、以下のオプション設定を構成します。

    設定

    説明

    SSL キー

    Jenkins サーバーがクライアント SSL 認証を必要とし、SSL クライアントキーをアップロードして YouTrack サービスを認証した場合は、ドロップダウンリストからクライアントキーを選択します。詳細については、SSL キーを参照してください。

    ソケットタイムアウト

    ソケットを切断する前に Jenkins サーバーからの応答を待つ最大時間を設定します。デフォルトは 30 秒です。

    読み取りタイムアウト

    接続を閉じる前に Jenkins サーバーからの完全なデータ転送を待つ最大時間を設定します。デフォルトは 30 秒です。

  5. 接続のテストボタンをクリックしてください。

    • YouTrack は Jenkins サーバーへの接続を確認します。

  6. 接続ボタンをクリックしてください。

    • Jenkins サーバーの接続設定が保存されます。

    • YouTrack インストールと指定した Jenkins インストール間の統合が有効になります。

他の Jenkins サーバーに接続を追加するには、これらの手順を繰り返します。

プロジェクト間のマッピングを定義する

Jenkins サーバーに接続すると、1 つ以上の YouTrack プロジェクトを Jenkins のプロジェクトにマップできます。管理者は、自分でプロジェクトをマッピングするか、プロジェクト管理者に自分のプロジェクトをマッピングさせることができます。プロジェクト管理者に適した詳細な手順については、Jenkins と統合するを参照してください。

設定の最初のグループは、YouTrack を Jenkins サーバー上のプロジェクトに接続します。デフォルトのブランチの追加オプションを使用すると、どの課題にビルド番号を割り当てるかを定義できます。統合によって処理されるすべての課題に適用するコマンドを指定することもできます。

YouTrack と Jenkins の間のマッピングを定義するには:

  1. ビルドサーバー統合のリストで Jenkins サーバーを選択します。

  2. 新しいマッピングボタンをクリックしてください。

    • 新規マッピングダイアログが開きます。

      Mapping options for a Jenkins integration.
  3. マッピング設定の値を設定します。各設定の詳細については、マッピング設定を参照してください。

  4. YouTrack が Jenkins によって処理されるビルドの VCS の変更をリッスンして対応するようにするには、VCS 変更の処理設定を展開します。それ以外の場合は、次の手順に進みます。

    フォームのこのセクションの設定の詳細については、VCS 変更の処理を参照してください。

  5. デフォルトのブランチでのビルドのアクション設定をクリックして展開します。これらの設定により、統合によって処理されるビルドと、ビルド番号が割り当てられる課題が決まります。

    Settings for actions in the default branch.

    これらの設定を使用して、統合を構成します。各設定の詳細については、ビルドのアクションを参照してください。

  6. マッピングの作成ボタンをクリックしてください。

    • YouTrack プロジェクトは、Jenkins のプロジェクトにマップされます。

    • Jenkins 統合が有効になり、選択した YouTrack プロジェクトで使用できるようになります。

マッピング設定

ビルドサーバー統合の新規マッピングダイアログでは、次の設定を使用できます。

設定

説明

メイン YouTrack プロジェクト

Jenkins のプロジェクトにマップする YouTrack プライマリプロジェクトを選択します。

追加プロジェクト

リンクされたビルドサーバーを 1 つまたは複数の追加プロジェクトと統合します。

Jenkins サーバー

マッピング先のプロジェクトが含まれている Jenkins サーバーを選択します。1 台の Jenkins サーバーにしか接続していない場合は、デフォルトで設定されています。

Jenkins の表示

Jenkins プロジェクトを含むビューの名前を選択します。

Jenkins プロジェクト

Jenkins プロジェクトを選択します。

課題の参照については、ブランチ名を確認してください

有効にすると、統合はコミットとプルリクエストのブランチ名にある課題への参照をチェックします。このオプションは、チケットごとのブランチプロセスを使用するチーム向けに含まれているため、開発者はコミットメッセージで課題 ID を明示的にメンションする必要がありません。

VCS 変更の処理

以下の設定は、ビルドサーバー統合の新規マッピングダイアログの VCS 変更の処理セクションで使用できます。

設定

説明

VCS 統合

統合が VCS 変更レコードを追加し、コミットメッセージで参照される課題のコマンドを処理するかどうかを決定します。

  • 有効にすると、YouTrack 課題 ID への参照を含む VCS の変更が、参照された課題のアクティビティストリームに追加されます。アクティビティストリームのエントリには、変更を含むビルドへのリンクが含まれています。

  • Disabled の場合、統合は、ビルドサーバーに接続されているリポジトリへのすべてのコミットを無視します。

    統合でカスタムフィールドにビルド番号を追加するだけの場合、またはすでに VCS との統合を直接構成している場合は、このオプションを無効にします。

課題にコマンドを適用する

YouTrack コマンドのコミットメッセージも解析するかどうかを決定します。YouTrack を有効にすると、アセンブルされたビルドに含まれているコミットメッセージで指定されているすべてのコマンドが、対応する課題に適用されます。

このオプションは、VCS 統合設定が有効になっている場合にのみ使用できます。有効にすると、コマンドをすべての統合プロジェクトの課題に適用するか、メインプロジェクトの課題にのみ適用するかを選択できます。

課題コメントに対するコミットを解析します

有効にすると、コミットメッセージ内の特定のテキスト行がコメントとして課題にコピーされます。コミットメッセージの一部をコメントとして課題にコピーすると、@mention 通知をトリガーし、VCS の変更にアクセスできないユーザーに情報を公開できます。

この設定は、コミットメッセージが VCS の変更にどのように表示されるかには影響しません。コマンドや課題のコメントを含むコミットメッセージ全体は、アクティビティストリームの VCS 変更レコードの一部として常に表示されます。

次の場合にのみこのオプションを有効にしてください。

  • コミットメッセージで他のユーザーにメンションし、テキストが issue のコメントにコピーされたときに通知を生成します。

  • VCS の変更の可視性を制限し、コミット関連の情報をコメントとして外部ユーザーに見えるようにします。

YouTrack がメッセージをコミットする方法の詳細については、VCS コミットでのコマンドの適用を参照してください。

VCS 変更の表示対象

アクティビティストリームで VCS の変更として表示されるコメントと更新の表示を制限するには、リストから 1 つ以上のグループまたはチームを選択します。それ以外の場合、このアクティビティタイプは、課題を読み取るための十分なアクセス権を持つすべてのユーザーに表示されます。

ビルドのアクション

ビルドサーバー統合の新規マッピング設定のビルドのアクションセクションでは、次のオプションを使用できます。

オプション

説明

アセンブルされたビルドからデータをプルする

統合がビルドサーバーによってアセンブルされたすべてのビルドをリッスンするか、キャンセルされたビルドを除外するか、成功したビルドのみを考慮するかを決定します。

カスタムフィールドの値のセットにビルド番号を追加する

統合された YouTrack プロジェクトでビルド番号が入力されるカスタムフィールドを決定します。選択は、build タイプを格納するカスタムフィールドに制限されています。

選択したフィールドの値は、統合によって更新されるすべての課題で自動的に設定されます。統合の更新する課題を選択してくださいセクションの設定により、ビルド番号が割り当てられる課題が決まります。

次のオプションを使用できます。

  • 課題を参照しないビルドを含める⏤統合によって処理されるすべてのビルドか、YouTrack 課題への参照を含むビルドのみかを決定します。このオプションで考慮されるビルドは、組み立てられたビルドからデータをプルする設定の影響を受けます。

    このオプションを有効にすると、ユーザーは最初に手動でビルド番号を追加しなくても、課題のビルド番号を手動で調整できます。

更新する課題を選択してください

このセクションのオプションにより、統合によってビルド番号が割り当てられる課題が決まります。次のオプションを使用できます。

  • 次の検索条件に一致するコミットメッセージまたはブランチ名で参照されている課題を更新します⏤統合がコミットメッセージまたはブランチ名に参照を含む課題を処理する方法を決定します。

    クエリ入力フィールドを使用して、自動ビルド番号割り当てから除外したいメンションのある課題を除外します。コミットメッセージで参照されている課題を更新するオプションが選択解除されている場合、フィルターも同様に無視されます。

  • 次の検索条件に一致する課題を更新します issue 課題の参照が含まれているかどうかにかかわらず、どの課題にビルド番号を割り当てるかを決定します。

    標準の検索基準は次のとおりです。

    State: Fixed State: Verified resolved date: ${prev.build.time} .. ${build.time}

    このクエリは、最後に成功したビルドと現在のビルド以降に解決された課題のみが考慮されることを保証します。

    検索条件に一致する課題を更新するオプションが選択解除されている場合、クエリも無視されます。

両方のオプションが有効になっている場合、ビルド番号はこれら 2 つの条件のいずれかを満たす課題に自動的に割り当てられます。

選択した課題を更新

自動ビルド番号の割り当てに加えて、統合が選択した課題に変更を適用するかどうかを決定します。コマンドを適用するオプションを有効にすると、ビルド番号が割り当てられているすべての課題に適用される定義済みのコマンドを入力できます。

${build} 変数を使用して、Jenkins のビルド番号を参照します。例:

Subsystem Testing Test in build ${build}

このコマンドを使用すると、YouTrack によって処理されるすべての課題がテストサブシステムに割り当てられ、ビルドテストフィールドがビルド番号に設定されます。

プレースホルダー

クエリおよびコマンド設定でプレースホルダーを使用できます。これらのプレースホルダーは、Jenkins のビルド用に保管されている属性を参照します。ビルドが YouTrack によって処理されると、プレースホルダーは接続されているバージョン管理システム内の対応する値に置き換えられます。以下のプレースホルダーが利用可能です。

プレースホルダー

説明

${build.time}

YouTrack によって処理されるビルドの日時。

${prev.build.time}

YouTrack によって処理されるビルドより前のビルドの日時。

${build}

YouTrack によって処理されたビルドの番号。

関連ページ:

VCS の変更の表示と編集

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

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

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

Jenkins と統合する

このページの指示に従って、YouTrack プロジェクトを Jenkins のプロジェクトと統合します。YouTrack と Jenkins の統合により、プロジェクトで次の機能が有効になります。接続されたプロジェクトからビルド番号をプルし、ビルド番号を格納するカスタムフィールドの値を自動的に更新します。コミットメッセージまたはブランチ名で参照される課題に VCS 変更レコードを追加します。YouTrack の課題における VCS の変更の詳細については、VCS の変更の表示と編集を参照してくだ...

SSL キー

YouTrack では、SSL キーストアを YouTrack にインポートできます。キーストアは、公開鍵と秘密鍵のペア、それらが関連付けられている証明書のコンテナーです。キーストアは、サードパーティーへの接続を試行するときに、YouTrack をクライアントとして識別します。キーストアを使用して、サードパーティサービスの公開キーを(証明書の形式で)キャッシュすることもできます。外部サービスのキーと証明書を含むキーストアがある場合は、このページでアップロードできます。それ以外の場合は、SSL 証...

ビルドサーバー統合

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

Kotlin DSL スニペット

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