From b092b2ca15c733f80dc0774cab062ada61b2fa16 Mon Sep 17 00:00:00 2001 From: Dan Lorenc Date: Wed, 10 Jun 2020 07:58:26 -0500 Subject: [PATCH] Clarify the API compatibility policy and improve the deprecations table. In discussion around #2697, we realized the existing API compatiblity policy is a little unclear, leading to confusion. We discussed and clarified the intentions of this policy in #2790. This change adds an example to the policy, and tweaks the deprecations table to make a bit more sense. Fixes https://github.com/tektoncd/pipeline/issues/2790 --- api_compatibility_policy.md | 4 +++- docs/deprecations.md | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/api_compatibility_policy.md b/api_compatibility_policy.md index e7ba2c44207..688ee924153 100644 --- a/api_compatibility_policy.md +++ b/api_compatibility_policy.md @@ -55,7 +55,9 @@ and we are following [the Kubernetes deprecation policy](https://kubernetes.io/d introduced in a backwards compatible manner first, with a deprecation warning in the release notes and migration instructions. * You will be given at least 9 months to migrate before a backward incompatible - change is made. + 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. ## Approving API changes diff --git a/docs/deprecations.md b/docs/deprecations.md index 926329a3eda..af0c0a6193d 100644 --- a/docs/deprecations.md +++ b/docs/deprecations.md @@ -18,7 +18,7 @@ being deprecated. ## Deprecation Table -| Feature Being Deprecated | Deprecation Announcement | [API Compatibility Policy](https://github.com/tektoncd/pipeline/tree/master/api_compatibility_policy.md) | Earliest Date of Removal | +| Feature Being Deprecated | Deprecation Announcement | [API Compatibility Policy](https://github.com/tektoncd/pipeline/tree/master/api_compatibility_policy.md) | Earliest Date or Release of Removal | | ------------------------ | ------------------------ | -------------------------------------------------------------------------------------------------------- | ------------------------ | | [`tekton.dev/task` label on ClusterTasks](https://github.com/tektoncd/pipeline/issues/2533) | [v0.12.0](https://github.com/tektoncd/pipeline/releases/tag/v0.12.0) | Beta | January 30 2021 | | [Step `$HOME` env var defaults to `/tekton/home`](https://github.com/tektoncd/pipeline/issues/2013) | [v0.11.0-rc1](https://github.com/tektoncd/pipeline/releases/tag/v0.11.0-rc1) | Beta | December 4 2020 |