TeamCity 2020.1ヘルプ

型付きパラメータ

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.

Consider a simple example. You have a build configuration in which you have a hard-to-read build parameter that regulates if a build has to include a license or not. The parameter can be either true or false, and is false by default. It may be clear for a build engineer, which build parameter regulates license generation and which value it is to have, but it may not be obvious to a regular user.

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

パラメータ仕様の追加

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

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

  • ラベル : some text that is shown near the control in the カスタムビルドを実行する dialog.

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

  • 表示 :
    • if hidden is selected, the parameter will not be shown in the カスタムビルドを実行する 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.

  • 読み取り専用 : if the box is checked, it will be impossible to override the parameter with a different value.

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

    • チェックボックス;

    • 選択コントロール。

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

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

タイプ

説明

テキスト

The default option. Represents a usual text string without any extra handling

チェックボックス

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

選択

"Select one" or "select many" control to set the value to one of predefined settings.

パスワード

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

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

テキスト

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

チェックボックス

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

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

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

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

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

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

選択

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

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

Alternatively, you can manually configure a specification using a specially formatted string with the syntax similar to the one used in service messages ( typeName key='value' ).
For example, for the text label: 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 パラメーターの編集 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を使用して、型指定されたパラメーターの仕様を表示/編集することもできます。