TeamCity 2019.1ヘルプ

型付きパラメータ

ビルドパラメーター (システムプロパティー、環境変数、または構成パラメーター)を追加する場合、パラメーターのコントロールの表示と検証を規制する仕様で定義を拡張できます。この仕様は、カスタムビルドを開始するダイアログでパラメーターを表示するために使用されるパラメーターの「メタ」情報です。カスタムビルドをより使いやすく、開発者以外でも使用できるようにします。簡単な例を考えてみましょう。ビルドにライセンスを含める必要があるかどうかを規制する、見た目が悪いビルドパラメーターがあるビルド構成があります。trueまたはfalseのいずれかです。デフォルトではfalseです。ビルドエンジニアにとっては、どのビルドパラメーターがライセンス生成を規制し、どの値を持つべきかは明らかかもしれませんが、通常のユーザーには明らかではないかもしれません。

ビルドパラメーターの仕様を使用すると、カスタムビルドを実行するダイアログでパラメーターを読みやすくすることができます。

このページで:

パラメータ仕様の追加

ビルドパラメーターに仕様を追加するには、ビルドパラメーターの編集/追加時にスペック領域の編集ボタンをクリックします。

すべてのパラメータ仕様は、次のような多くの共通プロパティーをサポートしています。

  • ラベル : カスタムビルドの実行ダイアログのコントロールの近くに表示されるテキスト。

  • 説明 : コントロールの使用に関する説明を含むコントロールに表示されるテキスト。

  • 表示 : hiddenが指定されている場合、パラメーターはカスタムビルドを実行するダイアログに表示されませんが、ビルドに送信されます。プロンプトが指定されている場合、TeamCityは実行ボタンをクリックするときにパラメーター値のレビューを常に必要とします(ビルドが自動的にトリガーされる場合はパラメーターを必要としません)。normalが選択されている場合、パラメーターは通常どおり表示されます。

  • 読み取り専用 : ボックスがチェックされている場合、別の値でパラメーターをオーバーライドすることはできません

  • : 現在、次の形式でパラメータを提示できます。
    • 正規表現を使用して値を検証する機能を備えたシンプルなテキストフィールド。

    • チェックボックス;

    • 選択コントロール。

    • パスワードフィールド。

次の表に、各コントロールタイプの詳細を示します。

説明

テキスト

デフォルト: 追加の処理なしで通常のテキスト文字列を表する

チェックボックス

チェックボックスで表されるTrue / Falseオプション

選択

「1つ選択」または「複数選択」コントロールを使用して、事前定義された設定のいずれかに値を設定する

パスワード

これは、TeamCity設定でパスワードまたはその他の安全なデータを保存するように設計されています。TeamCityは、TeamCity Web UIにパスワードパラメーターの値を表示しないようにします。これは、設定画面と、パスワードフィールドが表示されるカスタムビルドを実行するダイアログに影響します。また、ビルドのパラメータータブとビルドログで値が置き換えられます。値は、TeamCity Data Directoryの構成ファイルにスクランブルされて保存されます。ビルドログ値の非表示は、単純な検索と置換で実装されるため、「123」という単純なパスワードがある場合、「123」のすべての出現が置き換えられ、パスワードが公開される可能性があることに注意してください。パスワードを入力するようにパラメーターを設定しても、生の値を取得できないことは保証されません。プロジェクト管理者はそれを取得でき、ビルドスクリプトを変更できる開発者は理論的にはパスワードを取得するために悪意のあるコードを作成できます。

仕様のタイプに応じて、追加の設定があります。

テキスト

許容値 - 許容値を選択してください。正規表現オプションの場合、フィールド値を検証するJavaスタイルの正規表現パターン検証メッセージを指定します

チェックボックス

チェック値 / 未チェックの値:チェックボックスの状態に応じて、パラメーターの値を指定します。

チェック済みの値指定し、パラメーターのデフォルト値と未チェックの値を同じにすることをお勧めします。

ビルドがトリガーされる方法に応じて、チェックボックスの動作は次のようになります。

  • 自動トリガーまたは実行ボタン( カスタムビルドの実行ダイアログなし)をクリックしてビルドがトリガーされる場合、デフォルト値が使用されます

  • 何も変更せずにカスタムビルドの実行ダイアログを介してビルドがトリガーされた場合、「未チェックの値」が使用されます(空でない場合): 空の場合、デフォルト値が使用されます

  • ボックスがチェックされた状態でカスタムビルドの実行ダイアログを介してビルドがトリガーされた場合、「チェックされた値」が使用されます(空でない場合): 空の場合、「true」値が使用されます

選択

複数許可ボックスをオンにして、複数選択を有効にします。項目フィールドで、改行で区切られたアイテムのリストを指定します。次の構文 label => value または valueを使用します。

パラメータ仕様の手動設定

または、サービスメッセージ(typeName key='value')で使用されている構文と同様の構文を持つ特別にフォーマットされた文字列を使用して、仕様を手動で構成できます:
例:テキスト: text label='some label' regex='some pattern'

パラメータ仕様のコピー

仕様を持つパラメーターの編集を開始すると、パラメーターの編集ダイアログにその未加工値へのリンクが表示されます。クリックすると、仕様が未加工の形式(サービスメッセージ形式)で表示されます。この仕様を別のビルド構成で使用するには、ここからコピーして、別の構成に貼り付けます。

REST APIを介したパラメーター仕様の変更

REST APIを使用して、型指定されたパラメーターの仕様を表示/編集することもできます。


関連事項:

管理者ガイド : ビルドパラメータの設定 | ビルド構成でのビルドパラメータの定義と使用 | 定義済みのビルドパラメータ