Aggrega Infrastructure Base (Recipe) スキーマ
自動生成されたリファレンスです。手動で編集しないでください。公開されている JSON Schema から再生成してください。
スキーマ ID: https://aggrega.ai/schemas/recipe-v1beta1.schema.json
Dev の意図を特定のインフラストラクチャプロバイダーに結び付ける、Ops が記述するポインター兼マッピングのレイヤーです。物理的なプロバイダーおよびカタログのコンポーネントと厳密に 1:1 で対応します。
Recipe エンティティの記述に関する解説は Recipe 記述リファレンスを参照してください。このページでは、そのリファレンスが説明する構造上のスキーマを記載します。
トップレベルの型: object
プロパティ
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | はい | 定数: "aggrega.ai/v1beta1" |
kind | const “Recipe” | はい | 定数: "Recipe" |
metadata | object | はい | |
spec | object | はい | Recipe のプロバイダーバインディング、ソース、値マッピング、パイプラインです。加算によって合成される 3 種類の入力をサポートします: sourced(source と valuesMapping のオーバーレイ)、synthesized(workload)、artifacts(名前付きの出力ファイル)。これらとは別に、Recipe は自身がレンダリングされる境界の共有出力に、‘boundary’ の下でファイルを提供できます。 |
追加のプロパティは許可されません。
recipe.metadata
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | 1 文字以上。 |
version | string | はい | 実装 recipe の厳密なセマンティックバージョニング(例: 2.1.0)です。パターン: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$。 |
description | string | いいえ | このエンティティが何であり、何のためのものかを、使用するかどうかを判断する人に向けて書きます。まずそれが何かを示す一文で始め、次に読者がそれを選び正しく使うために必要なこと、つまりそれをデプロイする Release に何を期待するか、そしてその振る舞いについて意外な点を加えます。通常は短い段落程度の長さです。 |
maintainers | object[] | いいえ | このエンティティを所有するメンテナーの一覧です。 |
license | string | いいえ | このエンティティが記述するソフトウェアのライセンスの SPDX 識別子です(MIT や AGPL-3.0 など)。記録するのはそのソフトウェアの条件であり、このファイルの条件ではありません。 |
repository | string | いいえ | ソースファイルが置かれている Git リポジトリの URL です。 |
home | string | いいえ | このエンティティのホームページ、wiki、またはドキュメントの URL です。 |
keywords | string[] | いいえ | UI での発見性を高めるための説明的なキーワードの一覧です。 |
追加のプロパティは許可されません。
recipe.metadata.maintainers[]
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | |
email | string | いいえ | |
url | string | いいえ |
追加のプロパティは許可されません。
recipe.spec
Recipe のプロバイダーバインディング、ソース、値マッピング、パイプラインです。加算によって合成される 3 種類の入力をサポートします: sourced(source と valuesMapping のオーバーレイ)、synthesized(workload)、artifacts(名前付きの出力ファイル)。これらとは別に、Recipe は自身がレンダリングされる境界の共有出力に、‘boundary’ の下でファイルを提供できます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
capability | string | はい | この recipe がバインドする明示的なプロバイダー機能(例: ‘helm’、‘terraform’、‘compose’)、つまりこれをレンダリングするプロバイダーの種類です。‘implements’ と同じ 3 つの形式で、任意のバージョン固定を受け付けます: バージョンなし(‘helm’)、完全一致(‘helm:1.0.0’)、メジャー互換範囲(‘helm:^1.0.0’)。名前のみの部分はプロバイダーの種類を選択し、固定がある場合は、その機能を提供するプロバイダーレンダリングプラグインのどのバージョンがこの recipe をレンダリングするかを選択します。固定がなければ利用可能な最高バージョン、完全一致の固定ならそのバージョン、キャレットなら範囲内の最高バージョンです。どの提供プラグインのバージョンも満たさない固定は、ビルドを明示的に停止させます。プロバイダー選択より後の処理(出力のグループ化、パスセグメント、パイプラインの互換性、コーデックの選択)はすべて名前のみの機能をキーとするため、同じ機能の異なるプラグインバージョンを固定する 2 つの recipe が 1 つのビルド内に共存できます。 |
implements | string | はい | この recipe が実装できるカタログのコンポーネント型を宣言します(完全一致バージョン ‘core/api-server:1.0.0’、メジャー互換範囲 ‘core/api-server:^1.0.0’、またはバージョンなし ‘core/api-server’)。コンパイラはこれを Manifest のマッピングの検証と、診断およびエディター補完での候補の提示に使用しますが、ビルドの解決には決して使用しません。aggrega lint もこれを読み取り、Recipe の公開キーとの比較対象となる、宣言された provides 契約を持つ Component を特定します。Manifest のマッピングはユーザーによる明示的な実装の選択であり、Release のロックファイルで固定されます。 |
source | string または object | いいえ | インフラストラクチャコードの場所です。URI 文字列、またはプロバイダー定義のキーが Recipe のテンプレートに ‘.source.*’ として公開される、オープンな構造化オブジェクトを受け付けます。 |
locals | string のマップ | いいえ | Private Ops State です。この Recipe のテンプレート内で ‘.locals.*’ として利用できる内部計算結果です。各エントリ自体が Go テンプレートであり、自己完結したノードローカルのコンテキスト(‘.context.instance_id’、‘.values’、‘.infra’、およびこの同じブロックのうちそれまでに解決されたエントリ)に対して評価されます。エントリは記述された順に解決され、エントリは自身より「上」で定義された兄弟エントリを読み取ることができ、その兄弟のテンプレートテキストではなく解決済みの値を受け取ります。あるエントリが別のエントリを読み取る場合、記述順は契約の一部です。定義をその読み取り側より下に移動するとビルドが壊れ、参照を解決させるためにブロックが並べ替えられることはありません。このブロックが「後で」定義するエントリへの ‘.locals. |
provides | string、number、または boolean のマップ | いいえ | Public Developer API です。下流の Caller による inject の解決に利用できる、契約上の出力変数です。コンパイラは provides テンプレートを自己完結したコンテキストに対して、相互に任意の順序で評価します。provides のエントリが別のエントリを読み取ることはありません。ノードの locals は provides より先に locals プリアンブルで解決されるため、provides テンプレートは ‘.locals’ を読み取って解決済みの値を受け取れます。locals ブロックが宣言していないキーを示すと停止します。呼び出し元は inject のハイドレーション時に、これらの値に対して inject キーを解決します。値はスカラーであり、パイプはそれをそのまま運び、注入境界で決定的に文字列化します。 |
valuesMapping | string または object | いいえ | 内容の形によるディスパッチで 3 つの記述モードを持つ値マッピングの内容です。モード 1(インライン): Aggrega のコンテキスト(.values、.features、.infra)からプロバイダーが期待する値の形式を生成する Go テンプレートの文字列スカラー(通常はブロックスカラー YAML |)。モード 2(ファイルインポート): ローカルの Go テンプレートファイルを指す、キーがちょうど 1 つの YAML マップ $import: ./relative/path.tmpl。モード 3(ライブラリインポート): 名前のみの識別子で MappingLibrary のエントリを参照する、キーがちょうど 1 つの YAML マップ $import: <Library>#/mappings/<entry>(バージョンは Release ごとのロックファイルから提供され、参照にレジストリホストは含まれません)。オブジェクト形式では、$import は ^oci:// に一致してはならず、一致する値は拒否されます。 |
workload | string または object | いいえ | コンテンツの形状によるディスパッチで 3 つの記述モードを持つ Workload YAML の生成元です。モード 1(インライン):出力が ‘aggrega.ai/v1beta1 Workload’ としてパースされる Go テンプレートの文字列スカラーです。モード 2(ファイルインポート):キーがちょうど 1 つの YAML マップ $import: ./relative/path.yaml で、ローカルの Go テンプレートファイルを指します。モード 3(ライブラリインポート):キーがちょうど 1 つの YAML マップ $import: <Library>#/workloads/<entry> で、WorkloadLibrary のエントリをバージョンなしの名前による同一性で参照します(バージョンは Release ごとのロックファイルが提供し、参照にレジストリホストは現れません)。対象の Provider は workload の合成をサポートしている必要があります。標準ライブラリのカタログは、そうした provider に、文書化された契約として workloadSchema を宣言しています。合成できない provider にバインドされた workload: の Recipe は、レンダリング時に明示的に停止します。オブジェクト形式では、$import は ^oci:// に一致してはならず、一致する値は拒否されます。 |
artifacts | string または object のマップ | いいえ | エントリ名からアーティファクト内容の記述へのマップです。各エントリの値は、コンテンツの形状によるディスパッチで 3 つのモードのいずれかを取ります。モード 1(インライン):出力がアーティファクトの本文となる Go テンプレートの文字列スカラーです。モード 2(ファイルインポート):キーがちょうど 1 つの YAML マップ $import: ./relative/path.yaml で、ローカルの Go テンプレートファイルを指します。モード 3(ライブラリインポート):キーがちょうど 1 つの YAML マップ $import: <Library>#/artifacts/<entry> で、ArtifactLibrary のバンドルをバージョンなしの名前による同一性で参照します(バージョンは Release ごとのロックファイルが提供し、参照にレジストリホストは現れません)。バンドルはファイルごとに 1 つの出力に展開され、それぞれエントリのキーの下に <key>/<filename> として配置されます。キーはエントリの出力を名付けます。モード 1 またはモード 2 のエントリのキーはその出力ファイル名で、書かれたとおりに使われます。モード 2 のエントリでインポートされるファイルは内容を提供しますが出力を名付けないため、同じ名前を持つ別々のファイルをインポートする 2 つのエントリは、2 つの別個の出力になります。アーティファクトのエントリ、バンドルのファイル、source の出力、workload の合成の間で衝突が起きると、ノードのレンダリング時にビルドが停止します。artifacts ブロックは Recipe でも FeatureRecipe でも同じように記述します。3 つのモード、キーから出力への規則、衝突時の振る舞いはいずれも同じであり、そのためこの説明のその部分は両方の種類で同じ内容になっています。一方のために書かれた例は、そのままもう一方にも当てはまります。オブジェクト形式では、$import は ^oci:// に一致してはならず、一致する値は拒否されます。キー:キーはエントリの出力を名付けるため、単一のファイル名に制限されます。英字または数字で始まり、英字、数字、ドット、ハイフン、アンダースコアが続きます。先頭以外のドットは、アーティファクトのキーが持つ拡張子(main.tf、template.yaml、serviceaccount.yaml)を保つためのものです。/ があると 1 つのキーがファイルではなくパスを名付けることになり、先頭の . を許すと、出力ディレクトリの外の場所を指す .. を受け入れることになります。先頭文字の文字クラスはその両方を拒否します。ライブラリインポートでは、キーはバンドルのファイルが配置されるディレクトリを名付けるため、同じ制限が適用されます。パターン:^[A-Za-z0-9][A-Za-z0-9._-]*$。 |
omits | object[] | いいえ | この Recipe の source がレンダリングするもののうち、除外するものです。そのまま取り込んだ source が、Release で出荷してはならないものをレンダリングする場合のためのものです。たとえば、取得したチャートがレンダリングするドキュメント(チャートがレンダリングのたびに新たに生成するキーを保持する Secret など)、取得した compose ファイルに含まれる service、volume、config、取得した CloudFormation テンプレートが宣言するリソースです。ほとんどの Recipes では必要ありません。各エントリは、source がレンダリングする 1 つの単位を、その種類、名前、およびエントリが指定する場合は名前空間とその単位の由来となったサブチャートによって名付けます。いずれも source をレンダリングする provider の語彙で表します。チャートでは、ドキュメント自身の kind と metadata.name によるドキュメント、compose ファイルでは、services:、volumes:、configs: の下のキーによる service、volume、config、CloudFormation テンプレートでは、Type と論理 ID によるリソースです。その provider は、エントリに一致するすべての単位を除外します。エントリが何に一致するか、またエントリを理由に provider が何を拒否するかは、その provider 自身が文書化した契約です。何も除外できない provider は、このキーを宣言する Recipe を、何かがレンダリングされる前に拒否します。フィルタされるのは source: がレンダリングするものだけで、workload: や artifacts: のエントリは決してフィルタされません。そのため、このキーには source が必要です。すべての値はテンプレートで、valuesMapping と同じコンテキストに対して評価されます。エントリの when が最初に評価され、when が偽となる値をレンダリングしたエントリは除外されます。有効なまま残ったエントリはすべて、何かを除外しなければなりません。source がレンダリングしたものに何も一致しない有効なエントリは、そのエントリを示してビルドを停止します。source は引き続き完全にレンダリングされ(チャートのすべてのテンプレートは引き続き実行されるため、失敗するテンプレートは引き続きビルドを失敗させます)、除外されるのはその出力だけです。1 エントリ以上です。 |
boundary | object | いいえ | この Recipe が、自身の component の出力ではなく、レンダリング先の境界の共有出力に寄与するものです。ほとんどの Recipes では必要ありません。これは、対象が境界全体に対して 1 回だけ読み込むファイルのためのものです。たとえば Terraform の provider 設定は、Terraform が境界のルート設定でのみ受け付け、1 つの component のモジュール内では決して受け付けません。provider がこうしたファイルを受け付けるのは、その契約が boundaryArtifacts を宣言している場合だけで、宣言していない provider に対してこのブロックを宣言する Recipe は、何かがレンダリングされる前に拒否されます。FeatureRecipe はこのようなブロックを持ちません。 |
outputLabels | string のマップ | いいえ | Recipe の作成者が宣言するラベルで、この recipe のレンダリング出力が生成するすべてのオブジェクトに付与され、provider ごとのラベルの表現に変換されます(helm の合成、source のレンダリング、artifacts では Kubernetes の metadata.labels、Compose では service のラベル、Terraform の .tf.json アーティファクト本文ではリソースごとのタグ)。固定の来歴ラベルと同じ経路で運ばれますが、コンパイラではなく作成者が所有します。aggrega.ai/ と app.kubernetes.io/ の名前空間はプラットフォーム固有の来歴のために予約されており、読み込み時に拒否されます。対象の provider にとって有効なラベルでないキーや値は recipe 作成者の責任です。コアは、予約名前空間の規則以外にはラベルの文字セットを検査しません。 |
outputComponentLabels | string[] | いいえ | この recipe がレンダリング出力に昇格させる Component の識別ラベルのキーです。各エントリはラベルキーを 1 つ指定し、その値はこの recipe がレンダリングする component インスタンスのラベルから取得されます。そのため、付与されるラベルはここで繰り返し記述された値ではなく、その component が宣言した値を持ちます。昇格されたラベルは outputLabels と同じラベルサーフェスに届きますが、outputLabels はその場で記述されたリテラルのキーと値のペアを持つ点が異なります。両方のブロックで宣言されたキーはロード時に拒否されるため、付与される各キーの出所は 1 つだけです。aggrega.ai/ および app.kubernetes.io/ の名前空間はプラットフォームネイティブの来歴情報のために予約されており、ロード時に拒否されます。component.aggrega.ai/hosting のようなスコープ付きキーはこれらの予約ルートの外にあるため、昇格できます。 |
pipeline | object[] | いいえ | レンダリング後に、レンダリングされたドキュメントセットに対して順に実行される Wasm パイプラインステップのリストです。各ステップは RFC 6902 パッチと副作用を返します。 |
assertions | string のマップ | いいえ | ビルド時のフィールド間検証です。各エントリは名前付きのアサーションです。キーはエラーメッセージに表示される安定したルール識別子で、値は {{ fail "message" }} による停止セマンティクスを持つ Go テンプレート文字列です。エンティティごとの複数の名前付きアサーションは、インスタンスごとに作成者が宣言した順序で評価され、最初に失敗したアサーションがビルドを停止します。Recipe のアサーションは、recipe のバインド後かつ provides の評価後、レンダリング前に評価され、その Recipe がソースとする特定のチャートやモジュールの実装上の不変条件を表します。テンプレートコンテキスト: .values / .infra / .uses / .features / .metadata に加えて .provides / .locals / .recipe。評価器は missingkey=error を使用するため、未定義のキーへの参照は no-such-key 診断とともに停止します。素の参照はフォールバックが実行される前に停止するため、この面では単純な default は省略可能なフィールドのフォールバックを提供しません。参照を hasKey でガードするか、存在チェックを直接行う optional ヘルパーを使用してください。index でキーを読み取ってもフォールバックは提供されません。index はマップが保持していないマップキーに対してそのキーを示して停止します。 |
追加のプロパティは許可されません。
recipe.spec.omits[]
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
kind | string | はい | 除外するユニットの種類です。ソースをレンダリングする provider の語彙で指定します。chart の場合はレンダリングされたドキュメント自身の kind(Secret など)、compose ファイルの場合は service、volume、config のいずれか、CloudFormation テンプレートの場合はリソースの Type(AWS::S3::Bucket など)です。ソースがレンダリングする種類を指定するものであり、構造化された source: が持つ kind: とは無関係です。テンプレートです。 |
name | string | はい | 除外するユニットの名前です。ソースをレンダリングする provider の語彙で指定します。chart の場合はレンダリングされたドキュメント自身の metadata.name、compose ファイルの場合は services:、volumes:、configs: の下にあるそのユニットのキー、CloudFormation テンプレートの場合はリソースの論理 ID、つまり Resources の下にあるそのキーです。テンプレートです。 |
namespace | string | いいえ | 除外するユニットが属する namespace です。エントリーがその namespace 内のユニットだけにマッチすべき場合に指定します。chart のレンダリング済みドキュメントのように、出力が namespace を持つ provider 向けです。省略された場合、または空文字列にレンダリングされた場合、エントリーは namespace にかかわらず、その種類と名前を持つユニットにマッチします。compose ファイルと CloudFormation テンプレートには namespace がなく、それらの provider は namespace を指定したエントリーを拒否します。テンプレートです。 |
subchart | string | いいえ | 除外する単位の由来となるサブチャートです。エントリが 1 つのサブチャートがレンダリングするコピーにだけ一致すべき場合に使います。チャートがサブチャートから組み立てられるように、入れ子になった source から組み立てられる source が対象です。チャートの場合は、サブチャート自身の名前、または親の依存関係が与える別名を指定し、入れ子のサブチャートの名前は最も外側から / でつなぎます(operator や operator/webhooks)。その場合、エントリはそのサブチャート自身の templates/ または crds/ からレンダリングされたドキュメントに一致し、チャート自身がレンダリングするドキュメントにも、その中に入れ子になったサブチャートがレンダリングするドキュメントにも一致しません。省略した場合、または空文字列にレンダリングされた場合、エントリは由来にかかわらず、その種類と名前の単位に一致します。その名前のサブチャートをレンダリングしないチャートは、エントリを名指ししてビルドを停止させます。compose ファイルと CloudFormation テンプレートにはサブチャートがなく、それらの provider はサブチャートを指定するエントリを拒否します。テンプレートです。 |
when | string | いいえ | エントリーの他のフィールドより先に評価されるインライン Go テンプレートです。偽と評価される値にレンダリングされた場合、エントリーは破棄されます。その他のフィールドは評価されず、このエントリーによって何も除外されず、マッチすることも要求されません。when が空または省略されている場合、エントリーは保持されます。真偽の判定は、真偽値のようなテンプレート出力に対する標準的な慣例に従います。文字列 true/True/TRUE、0 以外の数値、その他の空でない文字列は真、false/False/FALSE、空文字列、0 は偽です。レンダリングに失敗した when はビルドを停止します。 |
追加のプロパティは許可されません。
recipe.spec.boundary
この Recipe が、自身の component の出力ではなく、レンダリング先の境界の共有出力に寄与するものです。ほとんどの Recipes では必要ありません。これは、対象が境界全体に対して 1 回だけ読み込むファイルのためのものです。たとえば Terraform の provider 設定は、Terraform が境界のルート設定でのみ受け付け、1 つの component のモジュール内では決して受け付けません。provider がこうしたファイルを受け付けるのは、その契約が boundaryArtifacts を宣言している場合だけで、宣言していない provider に対してこのブロックを宣言する Recipe は、何かがレンダリングされる前に拒否されます。FeatureRecipe はこのようなブロックを持ちません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
artifacts | string または object のマップ | はい | ファイル名からファイル内容の記述へのマップで、この Recipe 自身の artifacts とまったく同じ形をとります。同じ 3 つのモード(インラインの Go テンプレート文字列、ローカルの Go テンプレートファイルの $import:、または ArtifactLibrary バンドルの $import: で、バンドルのファイルはエントリのキーの下に <key>/<filename> として入れ子になります)、同じキーからファイル名への規則、同じテンプレートコンテキストを持つため、エントリは artifacts エントリとまったく同様に .values、.infra、.locals などを読み取れます。異なるのは各ファイルが書き込まれる場所です。この component 自身のディレクトリではなく、境界の組み立て済み出力を保持するディレクトリに、provider 自身の組み立てがそこに書き込むファイルと並んで、一度だけ書き込まれます。すべてのエントリは、この Recipe が境界内でレンダリングする component ごとに評価され、それらの評価が生成するファイルは名前でマージされます。複数の component または複数の Recipes によって同一のバイト列に評価された 1 つの名前は 1 つのファイルになり、異なるバイト列に評価された 1 つの名前は、そのファイルとすべての寄与元を示してビルドを停止します。provider 自身の組み立てがすでに書き込む名前も同様です。このようなファイルには、どの component が書き込んだかを示す情報は付与されません。それを宣言したすべての component に属するためです。テンプレートが何もレンダリングしないエントリはファイルを書き込みません。エントリは provider には渡されず、provider はそれらを読まずに境界の出力の残りを書き込みます。オブジェクト形式では、$import は ^oci:// に一致してはならず、一致する値は拒否されます。キー: キーはファイルを指定するため、artifacts のキーが従う規則のもとで単一のファイル名に制限されます。文字または数字で始まり、文字、数字、ドット、ハイフン、アンダースコアが続きます。/ があると 1 つのキーがファイルではなくパスを指定することになり、先頭の . は .. を許してしまいます。これは境界の出力ディレクトリの外の場所を指します。最初の文字クラスはその両方を拒否します。ライブラリインポートの場合、キーはバンドルのファイルが入れ子になるディレクトリを指定するため、同じ制限が適用されます。パターン: ^[A-Za-z0-9][A-Za-z0-9._-]*$。1 エントリ以上です。 |
追加のプロパティは許可されません。
recipe.spec.pipeline[]
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | このステップのプログラム上の識別子で、このパイプラインのステップの中で一意です。2 つのステップで同じ id を宣言しているドキュメントは、読み込み時に拒否されます。同じパイプラインの後続ステップは、このステップの出力を .steps.<id>.outputs として読み取ります。パターン:^[a-zA-Z0-9_]+$。 |
plugin | string | はい | このステップが実行する Plugin エンティティへの参照です。常にプラグイン自身のソケット種別でスコープされます。形式は <pluginType>/<name> で、parser/yaml や parser/yaml:1.0.0 のように任意でバージョンを付けます。スコープは複数ある形式の一つではなく必須です。スコープのない name:version は拒否されます。2 つのソケットが同じ名前のプラグインを持つ場合があり、エンティティを解決可能にするのはスコープだからです。ビルドはエンティティを、コンテンツアドレス指定された .wasm アーティファクト(プラグインの識別子と設定されたレジストリから場所を特定し、そのダイジェストはロックファイルに固定されます)に解決し、バイト列を読み込みます。単独の .wasm やアーティファクトへの参照はここでは受け付けられません。 |
function | string | はい | 呼び出すエクスポート済みの Wasm 関数です。 |
with | string | いいえ | このプラグインの明示的な入力スキーマを厳密に満たす JSON/YAML マップに評価されるインライン Go テンプレートです。 |
optional | 真偽値 | いいえ | true の場合、このステップの失敗(ゲストのトラップ、セットに存在しないドキュメントを対象とするパッチ、不正な形式のパッチ、または停止レベルの診断)は目立つ警告に格下げされます。ステップ実行前のドキュメントセットが復元され、このステップの出力は破棄され、パイプラインは続行します。false または省略の場合、ステップが失敗するとステップ実行前のドキュメントセットを復元した後にビルドが停止します。 |
when | string | いいえ | パイプラインの走査時に評価されるインライン Go テンプレートです。偽と評価される値にレンダリングされた場合、ステップはスキップされます。これはパススルーであり、ドキュメントセットは変更されずに次のステップへ渡され、パッチ、副作用、ステップ記録は一切生じません。when が空または省略されている場合、ステップは常に実行されます。真偽の判定は、真偽値のようなテンプレート出力に対する標準的な慣例に従います。文字列 true/True/TRUE、0 以外の数値、その他の空でない文字列は真、false/False/FALSE、空文字列、0 は偽です。when と optional は独立しており、1 つのステップで両方を宣言できます。 |
追加のプロパティは許可されません。