サービスメッセージ

メッセージ作成タイムスタンプ

タイムスタンプの形式は、Java SimpleDateFormat の構文(英語)に従って yyyy-MM-dd'T'HH:mm:ss.SSSZ または yyyy-MM-dd'T'HH:mm:ss.SSS です。

例:

.NET DateTimeOffset(英語) の場合、このようなコード

になります

メッセージ FlowId

flowId は、ビルド内のメッセージフローの一意の識別子です。Flow トラッキングは、たとえば、並行して実行されている個別のプロセスを区別するために必要です。識別子は、個々のビルドのスコープ内で一意である必要がある文字列です。

ほとんどの場合、メッセージフローを開始するために必要な属性は flowId だけです。

ルートフロー内ではなく、既存のフロー内のサブフローとしてフローを開始する必要がある場合は、flowStarted パラメーターを追加し、親フロー ID を parent パラメーターとして指定します。親が指定されていないフローは、現在のステップのルートフロー内で開始されます。
サブフローを終了するには、flowFinished パラメーターを使用します。親フローを終了すると、すべてのサブフローが自動的に閉じますが、フローの順序を明示的に宣言することをお勧めします。

このカスタムサブフローの順序は、ビルドログの一連のレポートに影響を与え、結果をサブツリーとしてレポートできます。

サービスブロックメッセージ

ブロックはビルドログ内のいくつかのメッセージをグループ化するために使用されます。

ブロックオープニング:

blockOpened システムメッセージには name 属性があり、説明を追加することもできます。

ブロックを閉じる:

コンパイルメッセージの報告

where:

• compiler_name は、コンパイルを実行するコンパイラーの任意の名前です（例: javac または groovyc）。現在、ビルドログでブロック名として使用されています。

• compilationStarted と compilationFinished の間で報告されたステータス ERROR のメッセージは、コンパイルエラーとして扱われます。

レポートテスト

TeamCity のオンザフライテストレポートを使用するには、テストフレームワークがこの機能を動作させるための専用サポートが必要です（または、XML レポート処理を使用できます）。TeamCity がテストフレームワークをネイティブでサポートしていない場合、サービススクリプトを使用してテスト実行を TeamCity サーバーに報告するようにビルドスクリプトを変更できます。これにより、テスト結果をリアルタイムで表示し、ビルド結果ページのテストタブでテスト情報を利用できるようになります。

.NET コードカバレッジ結果の報告

サービスメッセージを使用して .NET カバレッジ処理を設定できます。詳しくはレポートカバレッジの手動設定のページを参照してください。

報告インスペクション

下記のサービスメッセージを使用して、カスタムツールからインスペクションを TeamCity に報告できます。

他の用途の中でも、インスペクションの数はビルドを失敗させるためのビルドメトリックとして使用できます。

インスペクションインスタンス

特定の不具合、警告、エラーメッセージを報告します。場所、説明、さまざまなオプションおよびカスタム属性が含まれています。

ここで、すべての属性は数値またはテキスト値を持つことができます。

• typeId — （必須）、255 文字で制限された上記の inspectionType.id への参照。

• message — （オプション）現在のインスタンスの説明は 4000 文字に制限されています。

• file — （必須）ファイルパスは 4000 文字に制限されています。パスは絶対パスにすることも、チェックアウトディレクトリからの相対パスにすることもできます。

• line — （オプション）ファイルの行、整数。

• additional attribute –任意の属性にすることができます。SEVERITY はここでよく使用され、次のいずれかの値になります（大文字に注意してください）: INFO、ERROR、WARNING、WEAK WARNING

例:

ビルドの進行中にアーティファクトを公開する

ビルドの実行中に、アーティファクトがビルドされた直後に、ビルドアーティファクトを公開することができます。

これを行うには、次の行を出力する必要があります。

<path> は、ビルド設定のアーティファクト仕様の構築と同じ規則に従う必要があります。 <path> に一致するファイルがアップロードされ、実行中のビルドのアーティファクトとして表示されます。

すべてのファイルの準備が整い、ファイルが読み取り用にロックされていないときにメッセージが表示されます。

アーティファクトはバックグラウンドでアップロードされるため、時間がかかる場合があります。一致するファイルがビルドの最後まで削除されていないことを確認してください（たとえば、次回のビルド開始時にクリーンアップされるディレクトリ、一時ディレクトリ、またはビルド後に Swabra を使用してクリーンアップすることができます）。

ビルド構成設定で指定されたアーティファクトは、通常どおりに公開されます。

ステップ間で NuGet パッケージを渡す

NuGet パッケージを公開してから、そのコンテンツを 1 つのビルド内で使用する必要がある場合は、ビルドの終了時ではなく、時間どおりに公開され、インデックスが作成されることを保証する必要があります。
このために、NuGet パブリッシュランナーを使用するか、代わりに任意のステップで ##teamcity[publishNuGetPackage] サービスメッセージを送信できます。これにより、NuGet パッケージは、現在のステップの最後に構成済みのすべての NuGet フィードで公開され、次のビルドステップで使用できるようになります。

ビルドの進行状況を報告する

特別な進行メッセージを使用して、ビルドスクリプト内の長時間実行されるパーツをマークできます。これらのメッセージは、対応するビルドのプロジェクトのダッシュボードとビルド結果ページに表示されます。

単一の進捗メッセージを記録するには、次のようにします。

この進行メッセージは、別の進行メッセージが表示されるまで、または次のターゲットが起動するまで表示されます（Ant ビルドの場合）。

ビルドの一部だけの進行状況メッセージを表示したい場合は、次のようにします。

ビルド問題の報告

ビルドスクリプトから直接ビルドを失敗させるには、ビルドの問題を報告する必要があります。ビルドの問題は、ビルドステータステキストに影響します。それらはビルド結果ページに表示されます。ビルドにビルドの問題を追加するには、次を使用します。

where:

• description （必須）: ビルドの問題を説明する人間が読めるプレーンテキスト。デフォルトでは、description はビルドステータステキストとビルドの問題のリストに表示されます。テキストは 4000 シンボルに制限されており、制限を超えると切り捨てられます。

• identity （オプション）: 一意の問題 ID。異なる問題は異なる ID、同じ問題を持っている必要があります。同じ ID。同じ問題、たとえば同じコンパイルエラーが発生した場合、ビルド全体で変更されるべきではありません。60 文字までの有効な JavaID である必要があります。省略した場合、identity は description テキストに基づいて計算されます。

ビルドステータスの報告

TeamCity を使用すると、ビルドスクリプトからビルドステータステキストを変更できます。進行状況メッセージとは異なり、この変更はビルドが終了した後も持続します。
失敗したビルドのビルドステータスを SUCCESS に変更することもできます。

ステータスを設定したり、ビルドステータスのテキストを変更したりするには（たとえば、テストフレームワークが TeamCity でサポートされていない場合は失敗したテストの数を書き留めます）、次の形式の buildStatus メッセージを使用します。

where:

• status （オプション）: SUCCESS 値を使用して、ビルドステータスを成功に変更します。

• text （必須）: 新しいビルドステータステキストを設定します。
  オプションで、テキストは {build.status.text} 置換パターンを使用できます。これは、合格したテストカウント、コンパイルメッセージなどを使用して TeamCity によって自動的に計算されたステータスを表します。
  ステータスセットはビルドの実行中に表示され、最終的なビルド結果にも影響します。

ビルド番号の報告

カスタムビルド番号を直接設定するには、次の形式で buildNumber メッセージを指定してください。

<new build number> 値では、{build.number} 置換を使用して、TeamCity によって自動的に生成された現在のビルド番号を使用できます。例:

ビルドパラメーターを追加または変更する

ビルドスクリプトで専用のサービスメッセージを使用することにより、ビルドステップからビルドのビルドパラメーターを動的に更新できます（パラメーターはビルド構成のパラメーターセクションで定義する必要があります）。変更されたビルドパラメーターは、変更後のビルドステップで使用できます。これらはビルドパラメーターとしても利用可能であり、 %dep.*% parameter references を介して依存ビルドで使用できます。例:

ビルドパラメーターの名前を指定するときは、プレフィックスに注意してください。

• システムプロパティの system

• 環境変数用の env

• 構成パラメーターのプレフィックスはありません。

ビルドパラメーターとその接頭辞についてのさらに読み込む。

ビルド統計の報告

TeamCity では、統計データをレポートし、そのデータに基づいてチャートを表示するようにビルドスクリプトを設定することができます。Web UI でチャートを表示するためのガイドについては、統計チャートのカスタマイズページを参照してください。このセクションでは、サービススクリプトを介してビルドスクリプトから統計データを報告する方法について説明します。ビルド統計値は、2 つの方法で公開できます。

• ビルドスクリプトでサービスメッセージを直接使用する

• teamcity-info.xml ファイルを使用してデータを提供する
  サービスメッセージを使用してビルド統計をレポートするには: レポートする統計値ごとに、次の形式で buildStatisticValue サービスメッセージを指定します。

where

• key は、事前定義されたキーのいずれとも等しくてはなりません。

• value は、最大 13 桁の正 / 負の整数でなければなりません。小数点以下 6 桁までの浮動小数点値もサポートされています。

サービスメッセージ処理の無効化

何らかの理由で出力内のサービスメッセージの検索を無効にする必要がある場合は、メッセージでサービスメッセージの検索を無効にすることができます。

これら 2 つの間に表示されるメッセージは、サービスメッセージとして解析されず、事実上無視されます。サーバー側のサービスメッセージの処理では、サービスメッセージの有効化 / 無効化も flowId 属性をサポートし、同じ flowId のメッセージのみを無視します。

XML レポートのインポート

UI ビルド機能に加えて、importData サービスメッセージを使用して、ビルドスクリプト内から XML レポートを設定できます。また、メッセージは以前に収集されたコードカバレッジとコードインスペクション / 重複レポートのインポートをサポートします。

サービスメッセージの形式は次のとおりです。

typeID は次のいずれかになります（XML レポート処理も参照）。

注:

1. path 属性の特定のファイルのみをサポートします。

2. インストールされた FindBugs ツールのホームディレクトリを指すように指定された findBugsHome 属性も必要です。

3. <tool name> が dotcover、partcover、ncover または ncover3 のいずれかである tool='<tool name>' サービスメッセージ属性も必要です。

特記しない限り、レポートタイプは path 属性で Ant のようなワイルドカードをサポートします。

• verbose='true' 属性はビルドログへの詳細なログインを可能にします。

• parseOutOfDate='true' 属性は、パスに一致するすべてのファイルを処理します。デフォルトでは、ビルド中に更新されたもの（最後の修正タイムスタンプによって決定されたもの）のみが処理されます。一致しないレポートが見つかった場合は、「レポートが期限切れとしてスキップされました」というメッセージがビルドログに表示されます。

• whenNoDataPublished=<action> （ <action> は次のいずれかです: info （デフォルト）、nothing、warning、error）は、指定されたパスに一致するレポートが見つからなかった場合、出力レベルを変更します。

• （代わりに非推奨、ビルド失敗条件を使用）
  findBugs、pmd、または checkstyle importData メッセージは、エラーと警告の制限を指定するオプションの errorLimit および warningLimit 属性も取ります。これを超えると、ビルドが失敗します。

複数のディレクトリの監視を開始したり、複数の種類のレポートを解析したりするには、対応するサービスメッセージを次々に送信します。