Skip to content

Commit 3d94678

Browse files
committed
[WIP] RFC: Add feature graduation process documentation
This commit adds the feature graduation process documentation to the API compatibility policy. It aims to mitigate the confusions of API versioning that was coupled with feature versioning as in #6592. related: TEP0138
1 parent 445734d commit 3d94678

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

api_compatibility_policy.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,21 @@ See the current list of [alpha features](https://github.com/tektoncd/pipeline/bl
136136

137137
- GA/Stable features will not be removed or changed in a backwards incompatible manner without incrementing the API Version.
138138

139+
### Feature Graduation Process
140+
Features start as experimental in alpha, are refined in beta, and are finalized in stable releases.
141+
142+
#### Introducing an `alpha` feature
143+
- When a feature is first introduced to Tekton, it will have the `alpha` stability level and be disabled by default.
144+
- At this stage, users could choose to experiment with the feature. Feedback will be collected from users and it will help maintainers to determine whether to promote the feature to higher stability level or deprecate it.
145+
146+
#### Promoting a feature to `beta`
147+
- After feedback of the usage of the alpha features, once the needs and motivations are validated, a feature could be promoted to `beta`. This stage is where features are further tested and refined.
148+
- The dedicated feature flag for this feature will then change the stability level only. It will still be disabled by default.
149+
150+
#### Graduating a feature to `stable`
151+
- This is the final stage of feature graduation process, where features are considered to be complete and ready to be released for the public.
152+
- Once a feature has graduated to `stable`, it will be turned on by default.
153+
139154
## Approving API changes
140155

141156
API changes must be approved by [OWNERS](OWNERS). The policy is slightly different

0 commit comments

Comments
 (0)