TeamCity 2020.2 ヘルプ

型付きパラメーター

When adding a build parameter (system property, environment variable or configuration parameter), you can extend its definition with a specification that will regulate the parameter's control presentation and validation. This specification is the parameter's meta-information that is used to display the parameter in the カスタムビルドを開始する dialog. It allows making a custom build run more user-friendly and usable by non-developers.

簡単な例を考えてみましょう。ビルドにライセンスを含める必要があるかどうかを規定する、読みにくいビルドパラメーターがあるビルド構成があります。パラメーターは true または false のいずれかで、デフォルトでは false です。ビルドエンジニアにとっては、どのビルドパラメーターがライセンス生成とそれが持つ価値を規定するかは明らかかもしれませんが、通常のユーザーには明らかでない場合があります。

Using the build parameter's specification you can make your parameters more readable in the Run Custom Build dialog.

パラメーター仕様の追加

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

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

  • ラベル : some text that is shown near the control in the Run Custom Build dialog.

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

  • 表示 :
    • if hidden is selected, the parameter will not be shown in the Run Custom Build dialog, but will be sent to a build;

    • if prompt is selected, TeamCity will always require a review of the parameter value when clicking the 実行 button (won't require the parameter if build is triggered automatically);

    • if normal is selected, the parameter will be shown as usual.

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

  • :
    • 正規表現を使用して値を検証する機能を備えたシンプルなテキストフィールド。

    • チェックボックス ;

    • 選択コントロール。

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

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

説明

テキスト

デフォルトのオプション。余分な処理なしで通常のテキスト文字列を表します

チェックボックス

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

選択

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

パスワード

This is designed to store passwords or other secure data in TeamCity settings. TeamCity makes the value of the password parameter never appear in the TeamCity web UI: it affects the settings' screens and the Run Custom Build dialog where password fields appear. Also, the value is replaced in the build's パラメーター tab and build log.

パスワード値は、TeamCity データディレクトリの設定ファイルに保存されます。サーバー暗号化設定に応じて、値はスクランブルされるか、カスタムキーで暗号化されます。

The build log value is hidden with a simple search-and-replace algorithm, so if you have a trivial password of "123", all occurrences of "123" will be replaced, potentially exposing the password. Setting the parameter to the password type does not guarantee that the raw value cannot be retrieved. Any project administrator can retrieve it, and any developer who can change the build script could potentially write malicious code to get the password.

Note that if you switch an existing parameter from the password type to any other type, the original password value will be lost.

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

テキスト

許容値 - 許可される値を選択します。正規表現オプションには、フィールド値を検証するための Java スタイルの正規表現であるパターンと、検証メッセージを指定します

チェックボックス

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

チェックされた値指定し、パラメーターの デフォルト値とチェックされていない値を同じに保つことをお勧めします。

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

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

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

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

選択

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

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

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

パラメーター仕様のコピー

If you start editing a parameter that has a specification, you can see a link to its raw value in the Edit parameter dialog. Click it to view the specification in its raw form (in the service message format). To use this specification in another build configuration, just copy it from here, and paste in another configuration.

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

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