Skip to content

Commit

Permalink
feat(deprecation): Add requirement on documentation (#95)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkerkhove authored Feb 24, 2023
1 parent 99b1b61 commit 67a95ef
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion DEPRECATIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,10 @@ When introducing a new deprecation, it must comply with the following rules:

- Every deprecation must be announced in the release notes and will be highlighted in the upcoming release(s)
- Every deprecation must have a warning in the KEDA logs to create awareness
- Every deprecation must be documented on `keda.sh` and explicitly mention timelines
- We recommend using this as inspiration: `# DEPRECATED: This parameter is deprecated as of KEDA v2.10 in favor of {replacement} and will be removed in version 2.12`
- Every deprecation must have a representing issue that is used for tracking breaking changes for our upcoming major version.
- Because of that, it must be labeled with [`breaking-change`](https://github.com/kedacore/keda/issues?q=is%3Aopen+label%3Abreaking-change+sort%3Aupdated-desc)
- A label will be added to indicate the version in which it will be removed, example `removal:keda-v2.12`.
- Every deprecation must be announced on [GitHub Discussions](https://github.com/kedacore/keda/discussions/categories/deprecations) ([example](https://github.com/kedacore/keda/discussions/3552))
- It should explain when the deprecation takes effect, what the impact is, how to migrate and when it will be removed.
- It should explain when the deprecation takes effect, what the impact is, how to migrate and when it will be removed.

0 comments on commit 67a95ef

Please sign in to comment.