TeamCity 2020.1ヘルプ

通知を購読する

TeamCity provides a wide range of notification possibilities to keep developers informed about the status of their projects. Notifications can be sent by email and instant messages, or can be displayed in the IDE (with the help of TeamCity plugins) or in the web browser. Notifications can also be received via Atom/RSS syndication feeds.

TeamCityの通知は、ユーザーが構成した通知規則に従ってユーザーごとに送信されます。通知ルールはユーザグループレベルでも設定できます。その場合、それらはグループ内のすべてのユーザに適用されます。

バージョン2020.1以降 , TeamCity also allows configuring notifications on a build configuration level.

プロジェクトレベルの通知のサブスクライブ

TeamCity allows you to flexibly adjust the notification rules, so that you receive notifications only on the events you are interested in. To subscribe to project-level notifications:

1. 画面の右上隅で、ユーザー名の横にある矢印をクリックし、ドロップダウンメニューから設定とツールを選択します。通知ルールタブを開きます。

2. Click the required notifications type and configure the required settings:

  • メール通知 *: relies on the email address specified in 設定とツール | 一般

  • IDEノーティファイア : the required TeamCity plugin must be installed in your IDE. For the details on installing TeamCity IDE plugins, refer to ツールをインストールします

  • Jabberノーティファイア *: expects entering a Jabber account name. Note that instead of Jabber you can specify your Google Talk account here if this option is configured by the System Administrator.

  • Slackノーティファイア : requires signing in to Slack and relies on the Slack connection configured in the project settings. Read more on how to configure the connection to Slack in 通知

  • (obsolete) Windowsトレイ通知機能 : Windowsトレイ通知機能 must be installed.

  • ブラウザ通知機能 : aims at replacing Windows Tray Notifier and requires installing the web browser extension.

3. 新しいルールを追加をクリックして、ダイアログでルールを指定します。通知ルールは2つの部分で構成されます。何を監視するかどのイベントについて通知するかです。以下の詳細を参照してください。

何が監視されます

以下のプロジェクトおよびビルド構成に関連するイベント

ビルドを監視したいプロジェクト/ビルド構成を選択します。プロジェクトに定義された通知ルールはそのサブプロジェクトに伝播されます。すべてのプロジェクトのビルド構成のすべてのビルドをモニターするには、ルートプロジェクトを選択してください。

選択したプロジェクト/ビルド構成内の通知を細かく制御するには、以下のオプションを使用します。

  • ブランチフィルター - 指定したブランチからのビルドについてのみアラートを受信するには、このオプションを選択します。さらに読むブランチフィルター

  • 変更だけでビルド - 通知を自分の変更のみを含むビルドに制限するには、このオプションを選択します。

システム全体のイベント

割り当てられた調査について通知を受けるように選択します。

通知をトリガーするイベント

ビルドが失敗する

指定したプロジェクトおよびビルド構成で完了したすべての失敗したビルドに関する通知を受け取るには、このオプションをオンにします。ビルドの進行中にビルド構成の調査が誰かに割り当てられた場合、失敗したビルド通知はそのユーザーにのみ送信されます。

ウォッチエリアで変更だけでビルドが選択されている場合、TeamCityはあなたの変更を伴うビルドが失敗した場合に通知し、その後成功したビルドまで各「未完了」ビルドで通知を送り続けるでしょう。不完全ビルドは、次のエラーのうちの少なくとも1つで失敗した完成ビルドです。

  • 実行タイムアウト

  • JVMがクラッシュしました

  • JVMのメモリー不足エラー

  • 変更を収集できません

  • コンパイル・エラー

  • 成果物の公開に失敗しました

  • 未知の失敗の理由

成功後、最初に失敗したビルドについてのみ通知する

このオプションをオンにすると、ビルドが成功した後に最初に失敗したビルドのみ、または変更を加えた最初のビルドについて通知されます。このオプションを使用すると、その後の失敗したビルドについて通知されません。

新しいビルドの問題または新しい失敗したテストについてのみ通知する

このオプションをオンにすると、ビルドが新しいビルドの問題または新しい失敗したテストで失敗した場合にのみ通知されます。

ビルドは成功しました

指定したプロジェクトとビルド構成のビルドが正常に実行されたときに通知を受け取るには、このオプションをオンにします。

失敗後、最初に成功したビルドについてのみ通知します。

失敗したビルドの後に最初に成功したビルドのみが発生したときに通知を受け取るには、このオプションをオンにします。その後の成功したビルドに関する通知は送信されません。

最初のエラーが発生しました

最初のビルドエラーが検出されるとすぐに(ビルドが完了する前であっても)「失敗した」ビルドに関する通知を受け取るには、このオプションをオンにします。

ビルドが始まります

ビルドが開始されたらすぐに通知を受け取るにはこのオプションをチェックしてください。

ビルドが起動しない

ビルドの開始に失敗したときに通知を受け取るには、このオプションをオンにします。

ビルドはおそらくハングしている

TeamCityがビルドをハングアップとして識別したときに通知を受け取るには、このオプションをオンにします。

調査が更新されました

このオプションをチェックすると、ビルド設定の変更やテスト調査のステータスの変更に関する通知を受け取ることができます。誰かが問題を調査しているか、問題が解決されたか、調査担当者が変更されました。

テストはミュートまたはミュート解除

影響を受けるビルド構成でテストミュートステータスの変更に関する通知を受け取るには、このオプションをオンにします。

割り当てられた調査

このオプションは、ウォッチ領域でシステム全体のイベントオプションが選択されている場合にのみ使用可能です。問題の調査を開始するたびに通知されるオプションをチェックしてください。

ルール処理順序

TeamCityは、表示されている順序で通知ルールを適用します。TeamCityは、ビルドがいずれかの通知規則に一致するかどうかを確認し、最初に一致した規則に従って通知を送信します。同じビルドに対する一致条件のそれ以上の検査は実行されません。設定した通知ルールを並べ替えることができます。

ユーザー規則が最初に適用され、次にグループ規則が適用されます。

グループルールは、子グループから親グループへと階層順に処理されます。

独自のルールセットを持つ複数の親がある場合、継承されたルールは通知ルールユーザープロファイルタブに表示される順序(アルファベット順)に対応して上下に処理されます。

既存のルールの購読解除と上書き

自分が所属しているユーザグループに対して、システム管理者によって通知ルールがすでに設定されている場合があります。

  • グループ通知の購読を解除または上書きするには、同じ監視対象ビルドと異なる通知イベントを使用して独自のルールを追加します。

  • すべてのイベントの購読を中止するには、対応する監視対象ビルドを含むルールを追加し、イベントを選択しないでください。

RSSフィード通知のカスタマイズ

TeamCityはRSSを通して特定のユーザの変更で完成したビルドまたはビルドについての情報を得ることを可能にします。配信フィードセクションを使用して設定とツールページのTeamCityツールサイドバーから(フィードURLジェネレータオプションを開くためにカスタマイズをクリックする)またはビルド設定のホームページからRSSフィードをカスタマイズできます。TeamCityは、Feed URL Generatorページで指定された値に基づいてシンジケーションフィードへのURLを生成します。

フィードURLジェネレータのオプション

オプション

説明

ビルド構成を選択

ビルド構成を一覧表示する

ビルド構成またはプロジェクトを選択するフィールドに表示するビルド構成を指定してください。以下のオプションがあります。

  • 外部ステータスを有効にして : このオプションが選択されている場合、次のフィールドにはステータスウィジェットオプションセットを有効にするを使用したビルド構成のリストが表示され、認証なしですべてのユーザーに表示されます。

  • Guestユーザーが利用可能 : このオプションを選択すると、Guest権限を持つユーザーに表示されるビルド構成の一覧が表示されます。

  • すべて : このオプションを選択すると、ビルド構成の完全なリストが表示されます。HTTP認証が必要です。このオプションを選択すると、フィード認証設定フィールドが有効になります。ビルド構成の外部ステータスが有効になっていない場合、フィードは承認されたユーザーにのみ利用可能になります。

ビルド構成またはプロジェクトを選択する

このリストを使用して、シンジケーションフィードを介して通知を受けるビルド構成またはプロジェクトを選択します。

フィードエントリの選択

のフィードアイテムを生成

シンジケーションフィードの生成をトリガーするイベントを指定します。ビルド、変更、またはその両方を選択することを選択できます。

ビルドを含める

通知を受けるビルドのタイプを指定します。

  • すべてのビルド

  • 成功しただけ

  • 失敗しただけ

ユーザーの変更でのみビルドされます

変更を通知したいユーザーを選択してください。サーバーに登録されているユーザーのリストから、すべてのユーザー、自分のユーザー、または特定のユーザーの変更に関するシンジケーションフィードを取得できます。

その他の設定

以下のオプションは、ビルド構成を一覧表示するセクションですべてが選択されている場合にのみ利用可能です。

フィード認証設定

HTTP認証用の認証情報を含める - このボックスをチェックして、自動認証用のユーザー名とパスワードを指定します。このオプションがチェックされていない場合は、フィードリーダーの認証ダイアログボックスにユーザー名とパスワードを入力する必要があります。

TeamCityユーザーパスワード - ...オプションがチェックされているときに設定可能です。HTTP認証に使用されるユーザー名とパスワードを入力します。

URLをコピーしてフィードリーダーに貼り付けるか、購読します。

このフィールドは、上記で指定された値に基づいてTeamCityによって生成されたURLを表示します。コピーしてフィードリーダーに貼り付けるか、サブスクライブリンクをクリックしてください。

サポートされているその他のURLパラメータ

フィードURLジェネレータで利用可能なURLパラメータに加えて、以下のパラメータがサポートされています。

パラメーター名

説明

itemsCount

数;フィードに返すアイテムの数を制限します。デフォルトは100です。

sinceDate

負の数分数を指定します。フィード要求の瞬間から指定された分数以内に終了したビルドのみが返されます。デフォルトは5日です。

template

フィードをレンダリングするために使用するカスタムテンプレートの名前(<template_name>)。ファイル <TeamCity Data Directory>\config\<template_name>.ftl がサーバー上に存在するはずです。ファイル構文の対応する節を参照してください。

デフォルトでは、フィードはAtomフィードとして生成されます。RSS 0.93形式でフィードを取得するには、フィードURLに &feedType=rss_0.93 を追加します。

サンプル

IDが bt1のビルド構成から、http://teamcity.server:8111(英語)アドレスにあるTeamCityサーバーからビルドを取得し、最後の1時間から開始したものに限定しますが、200項目以下にします。

http://teamcity.server:8111/httpAuth/feed.html?buildTypeId=bt1&itemsType=builds&sinceDate=-60&itemsCount=200