Skip to content

Commit

Permalink
Increase support window for v1beta1 CRDs to 1 year
Browse files Browse the repository at this point in the history
This commit updates the support policy for v1beta1 CRDs to 1 year,
to give users more time to migrate off of the v1beta1 API.

v1beta1 is considered a special case because there were no stable APIs
available when it was created. To avoid users becoming dependent on
future unstable APIs and inhibiting development, the existing policy
of 9 months will apply to future beta CRDs.
  • Loading branch information
lbernick authored and tekton-robot committed Jul 22, 2023
1 parent 83592de commit 81a77b6
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions api_compatibility_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ and follows the [beta policy](#beta-crds) for backwards incompatible changes.
- Any [backwards incompatible changes](#backwards-incompatible-changes) must be introduced in a backwards compatible manner first, with a deprecation warning in the release notes and migration instructions.

- Users will be given at least 9 months to migrate before a backward incompatible change is made. This means an older beta API version will continue to be supported in new releases for a period of at least 9 months from the time a newer version is made available.
- As a special case, the `v1beta1` CRDs will not be removed until 1 year after they are deprecated,
because no stable API was available when they were created. The 9 month policy will apply to future beta APIs.

- Alpha features may be present within a beta API version. However, they will not be enabled by default and must be enabled by setting `enable-api-fields` to `alpha`.

Expand Down

0 comments on commit 81a77b6

Please sign in to comment.