Skip to content

Commit

Permalink
Update API compatibility policy for stable CRDs
Browse files Browse the repository at this point in the history
This commit updates the API stability policy to clarify the stability levels
of existing CRDs.
  • Loading branch information
lbernick committed Apr 20, 2023
1 parent 79f6e4c commit ff05a3b
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions api_compatibility_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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 [deprecations.md](./docs/developers/deprecations.md).
Read more on additional considerations at [deprecations.md](./docs/developers/deprecations.md).

0 comments on commit ff05a3b

Please sign in to comment.