From a0b5cc55986818bff3c068f85e440e1236f172d1 Mon Sep 17 00:00:00 2001 From: Lee Bernick Date: Thu, 13 Apr 2023 11:40:23 -0400 Subject: [PATCH] Update API compatibility policy for stable CRDs This commit updates the API stability policy to clarify the stability levels of existing CRDs. --- api_compatibility_policy.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/api_compatibility_policy.md b/api_compatibility_policy.md index f77dc800923..e933dc3191c 100644 --- a/api_compatibility_policy.md +++ b/api_compatibility_policy.md @@ -31,14 +31,19 @@ The `apiVersion` field in a Tekton CRD determines whether the overall API (and i Within a stable CRD, certain opt-in features or API fields gated may be considered `alpha` or `beta`. Similarly, within a beta CRD, certain opt-in features may be considered `alpha`. See the section on Feature Gates for details. -The following CRDs are considered beta, though features may be introduced that are -alpha: +The following CRDs are considered stable, though features may be introduced that are +alpha or beta: -- `Task` -- `TaskRun` -- `ClusterTask` -- `Pipeline` -- `PipelineRun` +- `v1.Task` +- `v1.TaskRun` +- `v1.Pipeline` +- `v1.PipelineRun` + +`v1beta1.CustomRun` is considered a beta CRD. Adding new fields to `CustomRun` +that all `CustomRun` controllers are required to support is considered a [backwards incompatible change](#backwards-incompatible-changes), +and follows the [beta policy](#beta-crds) for backwards incompatible changes. + +`v1beta1.ClusterTask` is a deprecated beta CRD. New features will not be added to `ClusterTask`. ### Alpha CRDs @@ -155,4 +160,4 @@ but a change that renames the Go struct type for that field is allowed. ## Notes for Developers Are you a Tekton contributor looking to make a backwards incompatible change? -Read more on additional considerations at [api-changes.md](./docs/developers/api-changes.md#deprecations). \ No newline at end of file +Read more on additional considerations at [api-changes.md](./docs/developers/api-changes.md#deprecations).