Lược đồ Aggrega Infrastructure Base (FeatureRecipe)
Tài liệu tham khảo được sinh tự động. Không chỉnh sửa thủ công — hãy sinh lại từ JSON Schema đã xuất bản.
Id của lược đồ: https://aggrega.ai/schemas/featurerecipe-v1beta1.schema.json
Các định nghĩa do Ops soạn, ánh xạ một Feature trừu tượng của catalog sang một triển khai cụ thể, có phiên bản cho một khả năng của provider. Tương ứng nghiêm ngặt 1:1 với một provider vật lý và một feature trong catalog.
Xem tài liệu tham khảo về cách soạn FeatureRecipe để có hướng dẫn bằng văn xuôi về cách soạn các thực thể FeatureRecipe; trang này mô tả lược đồ cấu trúc mà tài liệu tham khảo đó trình bày.
Kiểu cấp cao nhất: object
Thuộc tính
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | có | Hằng số: "aggrega.ai/v1beta1" |
kind | const “FeatureRecipe” | có | Hằng số: "FeatureRecipe" |
metadata | object | có | |
spec | object | có | Liên kết năng lực provider, ánh xạ, pipeline và ánh xạ inject cho một FeatureRecipe. Mang cùng ba loại đầu vào như một Recipe (sourced, synthesized, artifacts) cộng với injectMapping chỉ có ở FeatureRecipe; một FeatureRecipe chỉ thuần nối dây, chỉ khai báo capability và implements, là hợp lệ và không render gì cả. |
Không cho phép thuộc tính bổ sung.
featurerecipe.metadata
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | có | Dài ít nhất 1 ký tự. |
version | string | có | Phiên bản theo Semantic Versioning nghiêm ngặt của FeatureRecipe (ví dụ: 1.2.5). Mẫu: ^(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 | không | Thực thể này là gì và dùng để làm gì, được viết cho người đang quyết định có dùng nó hay không. Mở đầu bằng một câu gọi tên nó, sau đó bổ sung những gì người đọc cần để chọn và dùng nó đúng cách — nó mong đợi gì từ Release triển khai nó, và bất cứ điều gì bất ngờ trong cách nó hoạt động. Độ dài thông thường là một đoạn ngắn. |
maintainers | object[] | không | Danh sách những người bảo trì sở hữu thực thể này. |
license | string | không | Mã định danh SPDX cho giấy phép của phần mềm mà thực thể này mô tả, chẳng hạn MIT hoặc AGPL-3.0. Nó ghi lại các điều khoản của phần mềm đó, không phải các điều khoản của tệp này. |
repository | string | không | URL đến kho Git chứa các tệp nguồn. |
home | string | không | URL của trang chủ, wiki hoặc tài liệu của thực thể này. |
keywords | string[] | không | Danh sách các từ khóa mô tả giúp dễ tìm kiếm trên giao diện người dùng. |
Không cho phép thuộc tính bổ sung.
featurerecipe.metadata.maintainers[]
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | có | |
email | string | không | |
url | string | không |
Không cho phép thuộc tính bổ sung.
featurerecipe.spec
Liên kết năng lực provider, ánh xạ, pipeline và ánh xạ inject cho một FeatureRecipe. Mang cùng ba loại đầu vào như một Recipe (sourced, synthesized, artifacts) cộng với injectMapping chỉ có ở FeatureRecipe; một FeatureRecipe chỉ thuần nối dây, chỉ khai báo capability và implements, là hợp lệ và không render gì cả.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
capability | string | có | Năng lực provider tường minh mà recipe này liên kết tới (ví dụ: ‘helm’, ‘terraform’, ‘compose’) — loại provider render nó. |
implements | string | có | Khai báo loại Feature nào trong catalog mà recipe này có thể triển khai (bao gồm các Features thông tin xác thực được gắn nhãn feature.aggrega.ai/kind: secret; phiên bản chính xác, khoảng tương thích major ’^’, hoặc không có phiên bản). Trình biên dịch dùng nó để xác minh các ánh xạ Manifest và để gợi ý ứng viên trong chẩn đoán và tính năng tự hoàn thành của trình soạn thảo; nó không bao giờ quyết định một bản build. Ánh xạ Manifest là lựa chọn hiện thực tường minh của người dùng, được ghim trong lockfile của Release. |
locals | map của string | không | Trạng thái Ops riêng tư. Các kết quả tính toán nội bộ chỉ khả dụng trong các template của FeatureRecipe này dưới dạng ‘.locals.*’. Mỗi mục tự nó là một Go template, được đánh giá trên một ngữ cảnh khép kín: ‘.context.instance_id’ (HOST COMPONENT mà attachment này đang được phân giải cho, và đó là điều tham chiếu ấy biểu thị trên mọi bề mặt template), ‘.attachment_name’ (thể hiện attachment đang được phân giải, và là con đường duy nhất tới tên đó từ một local), ‘.values’ và ‘.infra’ của chính attachment, cùng các mục của chính khối này đã được phân giải đến thời điểm đó. Các mục được phân giải theo thứ tự chúng được viết, và một mục CÓ THỂ đọc một mục anh em được định nghĩa PHÍA TRÊN nó, nhận giá trị đã phân giải của mục đó chứ không phải văn bản template của nó. Thứ tự do tác giả viết là một phần của hợp đồng ở bất cứ đâu một mục đọc mục khác: chuyển một định nghĩa xuống dưới mục đọc nó sẽ làm hỏng bản build, và khối này không bao giờ được sắp xếp lại để một tham chiếu phân giải được. Một tham chiếu ‘.locals. |
provides | map của string | không | API Developer công khai. Các biến đầu ra theo hợp đồng sẵn có cho việc phân giải inject của Caller ở hạ nguồn. Khi executionScope là boundary, các provides được đánh giá một lần cho attachment của boundary, theo ngữ cảnh template phạm vi boundary, và mọi component mà attachment chạm tới đều đọc lần đánh giá duy nhất đó tại ‘.features. |
source | string hoặc object | không | Đường dẫn tùy chọn tới mã hạ tầng. Chấp nhận một chuỗi URI hoặc một đối tượng có cấu trúc mở. Nếu được cung cấp cùng với valuesMapping, trình biên dịch sẽ render nó, và các tài liệu được render sẽ gia nhập đầu ra của FeatureRecipe trước khi các bước pipeline của nó chạy. |
valuesMapping | string hoặc object | không | Nội dung ánh xạ values với ba chế độ soạn thảo thông qua phân phối theo hình dạng nội dung. Chế độ 1 (nội tuyến): một chuỗi scalar Go template tạo ra định dạng values mà provider mong đợi. Chế độ 2 (nhập tệp): một map YAML có đúng một khóa, $import: ./relative/path.tmpl, trỏ tới một tệp Go template cục bộ. Chế độ 3 (nhập thư viện): một map YAML có đúng một khóa, $import: <Library>#/mappings/<entry>, tham chiếu một mục MappingLibrary theo định danh tên trần (phiên bản do lockfile của từng Release cung cấp; không có máy chủ registry nào xuất hiện trong tham chiếu). Ở dạng đối tượng, $import không được khớp với ^oci://; giá trị nào khớp sẽ bị từ chối. |
workload | string hoặc object | không | Trình tạo YAML Workload với ba chế độ soạn thảo thông qua phân phối theo hình dạng nội dung. Chế độ 1 (nội tuyến): một chuỗi scalar Go template có đầu ra được phân tích thành ‘aggrega.ai/v1beta1 Workload’. Chế độ 2 (nhập tệp): một map YAML có đúng một khóa, $import: ./relative/path.yaml, trỏ tới một tệp Go template cục bộ. Chế độ 3 (nhập thư viện): một map YAML có đúng một khóa, $import: <Library>#/workloads/<entry>, tham chiếu một mục WorkloadLibrary theo định danh tên trần (phiên bản do lockfile của từng Release cung cấp; không có máy chủ registry nào xuất hiện trong tham chiếu). Provider đích phải hỗ trợ tổng hợp workload; catalog thư viện chuẩn khai báo workloadSchema trên các provider như vậy làm hợp đồng được tài liệu hóa. Một FeatureRecipe có workload: được liên kết với một provider không thể tổng hợp sẽ dừng lại rõ ràng tại thời điểm render. Một workload FeatureRecipe được tổng hợp sẽ xuất các manifest gốc của provider vào thư mục đầu ra của feature. Ở dạng đối tượng, $import không được khớp với ^oci://; giá trị nào khớp sẽ bị từ chối. |
artifacts | map của string hoặc object | không | Ánh xạ từ tên mục đến nội dung artifact được soạn. Giá trị của mỗi mục mang một trong ba chế độ thông qua phân phối theo hình dạng nội dung. Chế độ 1 (nội tuyến): một chuỗi vô hướng Go template có đầu ra là phần thân của artifact. Chế độ 2 (nhập tệp): một map YAML có đúng một khóa, $import: ./relative/path.yaml, trỏ đến một tệp Go template cục bộ. Chế độ 3 (nhập thư viện): một map YAML có đúng một khóa, $import: <Library>#/artifacts/<entry>, tham chiếu đến một gói ArtifactLibrary theo định danh tên trần (phiên bản do lockfile của từng Release cung cấp; không có registry host nào xuất hiện trong tham chiếu). Một gói được mở rộng thành một đầu ra cho mỗi tệp, mỗi đầu ra lồng dưới khóa của mục dưới dạng <key>/<filename>. Khóa đặt tên cho đầu ra của mục: khóa của một mục chế độ 1 hoặc chế độ 2 là tên tệp đầu ra của nó, được dùng đúng như đã viết, và tệp được nhập của một mục chế độ 2 cung cấp nội dung mà không đặt tên cho đầu ra, vì vậy hai mục nhập hai tệp khác nhau có cùng tên là hai đầu ra riêng biệt. Các tài nguyên phụ trợ mà một FeatureRecipe tạo tài nguyên phát ra (ConfigMap, ServiceMonitor, NetworkPolicy, ExternalSecret CRD, v.v.) có dạng artifact; artifacts: là cơ chế tạo tài nguyên chính. Xung đột giữa các mục artifact, các tệp của gói, đầu ra của source và việc tổng hợp workload sẽ dừng bản build khi nút được render. Khối artifacts được soạn giống hệt nhau trên một Recipe và trên một FeatureRecipe — cùng ba chế độ, cùng quy tắc từ khóa đến đầu ra và cùng hành vi khi xung đột — đó là lý do phần này của mô tả đọc giống nhau trên cả hai loại; một ví dụ viết cho loại này có thể chuyển sang loại kia mà không cần thay đổi. Ở dạng object, $import không được khớp với ^oci://; một giá trị khớp sẽ bị từ chối. Khóa: Khóa đặt tên cho đầu ra của mục, vì vậy nó bị giới hạn ở một tên tệp duy nhất: bắt đầu bằng một chữ cái hoặc chữ số và tiếp tục bằng chữ cái, chữ số, dấu chấm, dấu gạch nối hoặc dấu gạch dưới. Dấu chấm sau ký tự đầu tiên giữ lại các phần mở rộng mà khóa artifact mang (main.tf, template.yaml, serviceaccount.yaml). Một / sẽ khiến một khóa đặt tên cho một đường dẫn thay vì một tệp, và một . ở đầu sẽ cho phép .., vốn chỉ một vị trí bên ngoài thư mục đầu ra — lớp ký tự đầu tiên từ chối cả hai. Với một lần nhập thư viện, khóa đặt tên cho thư mục mà các tệp của gói được lồng bên dưới, nên cùng giới hạn được áp dụng. Mẫu: ^[A-Za-z0-9][A-Za-z0-9._-]*$. |
omits | object[] | không | Những gì cần loại bỏ khỏi những gì source của FeatureRecipe này render — dành cho một source được dùng nguyên trạng mà render ra thứ Release không được phát hành: một tài liệu mà một chart được tải về render, chẳng hạn một Secret chứa khóa mà chart tạo mới ở mỗi lần render, một service, một volume hoặc một config mà một tệp compose được tải về đóng gói kèm, hoặc một tài nguyên mà một template CloudFormation được tải về khai báo. Hầu hết các FeatureRecipes không bao giờ cần đến nó. Mỗi mục đặt tên cho một đơn vị mà source render theo kind, tên của nó và, nếu mục có cung cấp, namespace của nó cùng subchart mà nó xuất phát, mỗi thứ theo từ vựng của provider đang render source — với một chart, một tài liệu theo kind và metadata.name của chính nó; với một tệp compose, một service, một volume hoặc một config theo khóa của nó dưới services:, volumes: hoặc configs:; với một template CloudFormation, một tài nguyên theo Type và logical ID của nó. Provider đó loại bỏ mọi đơn vị mà một mục khớp, và việc một mục khớp với gì, cũng như những gì provider từ chối vì một mục, là hợp đồng được tài liệu hóa riêng của provider đó. Một provider không thể loại bỏ bất cứ thứ gì sẽ từ chối một FeatureRecipe khai báo khóa này trước khi bất cứ thứ gì được render. Chỉ những gì source: render mới được lọc — một mục workload: hoặc artifacts: thì không bao giờ — vì vậy khóa này yêu cầu source. Mọi giá trị đều là một template, được đánh giá dựa trên ngữ cảnh mà valuesMapping được đánh giá. when của một mục được đánh giá trước, và một mục có when render ra giá trị falsy sẽ bị bỏ qua. Mọi mục còn hoạt động đều phải loại bỏ một thứ gì đó: một mục hoạt động không khớp với bất cứ thứ gì source đã render sẽ dừng bản build, kèm tên của mục. Source vẫn render đầy đủ — mọi template của một chart vẫn chạy, nên một template bị lỗi vẫn làm bản build thất bại — và chỉ đầu ra của nó bị loại bỏ. Khóa này được soạn giống hệt nhau trên một Recipe và trên một FeatureRecipe. Ít nhất 1 mục. |
injectMapping | string | không | Go template nội tuyến tùy chọn, được đánh giá trong giai đoạn Pre-Render Interception, một lần cho mỗi component mà attachment chạm tới, dựa trên ngữ cảnh template của component đó: nó đọc ‘.context’, ‘.features’ của component và ‘.attachment_name’, ‘.values’, ‘.infra’ và ‘.locals’ của attachment, bất kể executionScope là gì, và một tham chiếu đến ‘.boundary’, thứ không ngữ cảnh component nào mang, sẽ dừng bản build. Xuất ra một từ điển JSON/YAML mà trình biên dịch Go deep-merge một cách tự nhiên lên memory pipe ‘.context.inject’ của Caller. Dùng để biến đổi phía Caller đối với các biến môi trường và hợp đồng phân phối mà không cần Wasm. |
pipeline | object[] | không | Danh sách tuần tự các bước pipeline Wasm chạy sau khi render trên tập tài liệu đã render, mỗi bước trả về các bản vá RFC 6902 và các hiệu ứng phụ. |
executionScope | string (enum) | không | Liệu Resource Generation của FeatureRecipe này chạy theo từng component (mặc định) hay một lần cho mỗi lần gắn vào boundary. Các FeatureRecipes có phạm vi boundary được loại trùng lặp theo (boundary_path, instance FeatureRecipe) và mọi template trừ injectMapping đều đọc một ngữ cảnh template phạm vi boundary: các trụ .boundary.* thay vì các trụ .context.* theo từng component, và một tham chiếu đến các trụ này sẽ dừng bản build. injectMapping chạy một lần cho mỗi component mà attachment chạm tới bất kể executionScope, nên nó đọc ngữ cảnh của component đó và không bao giờ đọc .boundary. Giá trị cho phép: "component", "boundary" Mặc định: "component" |
readsCallerRenderFacts | boolean | không | Khai báo rằng các template của FeatureRecipe này đọc những gì các Components kết nối đến Component mà nó được gắn vào đã render: các render fact mà provider của mỗi caller đó báo cáo về đầu ra của chính nó. Khi giá trị là true và FeatureRecipe render theo từng component, mỗi lần gắn của nó sẽ render sau khi mọi Component trong bản build đã render, thay vì ngay sau Component mà nó được gắn vào, để bản render của mỗi caller hoàn tất trước khi lần gắn được đánh giá. Khi giá trị là false hoặc không có, không mục nào của caller trên ‘.context.used_by’ mang render fact, lần gắn render ngay sau Component của nó trừ khi readsTargetRenderFacts là true, và bản build dừng lại ở một template viết nội tuyến trong FeatureRecipe này mà đọc render fact của một caller bên dưới ‘.context.used_by’. Mặc định: false |
readsTargetRenderFacts | boolean | không | Khai báo rằng các template của FeatureRecipe này đọc những gì các Components mà Component nó được gắn vào kết nối tới đã render: các render fact mà provider của mỗi target đó báo cáo về đầu ra của chính nó, trên mỗi mục của ‘.context.uses’. Khi giá trị là true và FeatureRecipe render theo từng component, mỗi lần gắn của nó sẽ render sau khi mọi Component trong bản build đã render, thay vì ngay sau Component mà nó được gắn vào, để bản render của mỗi target hoàn tất trước khi lần gắn được đánh giá. Đây cũng chính là lần render muộn hơn mà readsCallerRenderFacts gây ra, nên việc đặt một trong hai khóa, hoặc cả hai, đều khiến lần gắn render vào lúc đó. Khi giá trị là false hoặc không có, không mục nào trên ‘.context.uses’ mang render fact, lần gắn render ngay sau Component của nó trừ khi readsCallerRenderFacts là true, và bản build dừng lại ở một template viết nội tuyến trong FeatureRecipe này mà đọc render fact của một target bên dưới ‘.context.uses’. Mặc định: false |
assertions | map của string | không | Kiểm tra hợp lệ chéo giữa các trường tại thời điểm build. Mỗi mục là một khẳng định có tên: khóa là một định danh quy tắc ổn định xuất hiện trong thông báo lỗi; giá trị là một chuỗi Go template với ngữ nghĩa dừng {{ fail "message" }}. Nhiều khẳng định có tên trên mỗi thực thể được đánh giá theo từng instance theo thứ tự tác giả khai báo; khẳng định thất bại đầu tiên sẽ dừng bản build. Các khẳng định của FeatureRecipe được đánh giá sau khi ràng buộc recipe và sau khi provides được đánh giá, trước khi render, và thể hiện các bất biến triển khai của chart hoặc module cụ thể mà FeatureRecipe lấy làm nguồn. Ngữ cảnh template: .values / .infra / .uses / .features / .metadata cùng với .provides / .locals / .recipe. Bộ đánh giá dùng missingkey=error: các tham chiếu đến khóa chưa được định nghĩa sẽ dừng lại với một chẩn đoán no-such-key. Vì tham chiếu trần dừng lại trước khi bất kỳ giá trị dự phòng nào kịp chạy, một default đơn thuần không cung cấp giá trị dự phòng cho trường tùy chọn trên bề mặt này — hãy chặn tham chiếu bằng hasKey, hoặc dùng helper optional, vốn thực hiện trực tiếp việc kiểm tra sự tồn tại. Việc đọc khóa thông qua index cũng không cung cấp giá trị dự phòng: index dừng lại ở một khóa map mà map không chứa, kèm tên của khóa. |
Không cho phép thuộc tính bổ sung.
featurerecipe.spec.omits[]
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
kind | string | có | Loại của đơn vị cần loại bỏ, theo từ vựng của provider kết xuất nguồn: với một chart, là kind riêng của một tài liệu được kết xuất, chẳng hạn Secret; với một tệp compose, là service, volume hoặc config; với một template CloudFormation, là Type của một tài nguyên, chẳng hạn AWS::S3::Bucket. Nó đặt tên cho một loại mà nguồn kết xuất, và không liên quan đến kind: mà một source: có cấu trúc mang theo. Là một template. |
name | string | có | Tên của đơn vị cần loại bỏ, theo từ vựng của provider kết xuất nguồn: với một chart, là metadata.name riêng của một tài liệu được kết xuất; với một tệp compose, là khóa của đơn vị dưới services:, volumes: hoặc configs:; với một template CloudFormation, là ID logic của tài nguyên, tức khóa của nó dưới Resources. Là một template. |
namespace | string | không | Namespace chứa đơn vị cần loại bỏ, khi mục chỉ nên khớp với một đơn vị trong namespace đó — dành cho một provider có đầu ra có namespace, như các tài liệu được kết xuất của một chart. Khi vắng mặt, hoặc kết xuất thành chuỗi rỗng, mục khớp với một đơn vị có loại và tên của nó bất kể namespace. Một tệp compose và một template CloudFormation không có namespace, và provider của chúng từ chối một mục có nêu namespace. Là một template. |
subchart | string | không | Subchart mà đơn vị cần loại bỏ xuất phát từ đó, khi mục chỉ nên khớp với bản sao do một subchart render — dành cho một source được lắp ráp từ các source lồng nhau, như một chart được lắp ráp từ các subchart của nó. Với một chart, đó là tên riêng của subchart, hoặc bí danh mà dependency của chart cha đặt cho nó, với các tên của một subchart lồng nhau được nối bằng / từ ngoài cùng: operator, hoặc operator/webhooks. Khi đó mục khớp với một tài liệu được render từ templates/ hoặc crds/ riêng của subchart đó, và không khớp với tài liệu do chính chart render hay tài liệu do một subchart lồng bên trong nó render. Nếu vắng mặt, hoặc render ra chuỗi rỗng, mục khớp với một đơn vị có kind và tên của nó bất kể nó xuất phát từ đâu. Một chart không render subchart nào có tên đó sẽ dừng bản build, kèm tên của mục. Một tệp compose và một template CloudFormation không có subchart, và các provider của chúng từ chối một mục đặt tên subchart. Một template. |
when | string | không | Template Go nội tuyến được đánh giá trước các trường khác của mục. Khi nó kết xuất ra một giá trị falsy, mục bị loại bỏ: các trường khác của nó không được đánh giá, không có gì bị loại bỏ vì nó, và nó không bắt buộc phải khớp. Một when rỗng hoặc vắng mặt giữ lại mục. Tính đúng sai tuân theo quy ước chuẩn cho đầu ra template dạng boolean: các chuỗi true/True/TRUE, mọi số khác không, và mọi chuỗi không rỗng khác là đúng, còn false/False/FALSE, chuỗi rỗng và số không là sai. Một when kết xuất thất bại sẽ dừng quá trình build. |
Không cho phép thuộc tính bổ sung.
featurerecipe.spec.pipeline[]
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
id | string | có | Một định danh lập trình cho bước này, duy nhất giữa các bước của pipeline này: một tài liệu khai báo một id trên hai bước của nó sẽ bị từ chối khi được đọc. Một bước sau trong cùng pipeline đọc đầu ra của bước này dưới dạng .steps.<id>.outputs. Mẫu: ^[a-zA-Z0-9_]+$. |
plugin | string | có | Tham chiếu đến thực thể Plugin mà bước này chạy, luôn được giới hạn phạm vi theo loại socket riêng của plugin: <pluginType>/<name> với một phiên bản tùy chọn, như trong parser/yaml hoặc parser/yaml:1.0.0. Phạm vi là bắt buộc chứ không phải một dạng trong số nhiều dạng — một name:version không có phạm vi sẽ bị từ chối, vì hai socket có thể chứa plugin cùng tên và phạm vi là thứ khiến thực thể có thể được phân giải. Quá trình build phân giải thực thể thành artifact .wasm được định địa chỉ theo nội dung của nó — được định vị từ danh tính của plugin và registry đã cấu hình, với digest được ghim trong lockfile — và tải các byte. Một tham chiếu .wasm hoặc artifact trần không được chấp nhận ở đây. |
function | string | có | Hàm Wasm được export cần gọi. |
with | string | không | Template Go nội tuyến được đánh giá thành một map JSON/YAML thỏa mãn nghiêm ngặt schema đầu vào tường minh của plugin này. |
optional | boolean | không | Khi là true, một lỗi của bước này (một guest trap, một patch nhắm đến tài liệu không có trong tập, một patch sai định dạng, hoặc một chẩn đoán ở mức halt) được hạ xuống thành một cảnh báo rõ ràng: tập tài liệu trước bước được khôi phục, đầu ra của bước này bị loại bỏ, và pipeline tiếp tục. Khi là false hoặc vắng mặt, mọi lỗi của bước sẽ dừng quá trình build sau khi khôi phục tập tài liệu trước bước. |
when | string | không | Template Go nội tuyến được đánh giá vào lúc duyệt pipeline. Khi nó kết xuất ra một giá trị falsy, bước bị bỏ qua — một bước chuyển tiếp: tập tài liệu đi đến bước tiếp theo mà không thay đổi, không đóng góp patch, tác dụng phụ hay bản ghi bước nào. Một when rỗng hoặc vắng mặt luôn chạy bước. Tính đúng sai tuân theo quy ước chuẩn cho đầu ra template dạng boolean: các chuỗi true/True/TRUE, mọi số khác không, và mọi chuỗi không rỗng khác là đúng, còn false/False/FALSE, chuỗi rỗng và số không là sai. when và optional độc lập với nhau: một bước có thể khai báo cả hai. |
Không cho phép thuộc tính bổ sung.