Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(deprecation): Add requirement on documentation #95

Merged
merged 2 commits into from
Feb 24, 2023
Merged

feat(deprecation): Add requirement on documentation #95

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2bf1974
feat(deprecation): Add requirement on documentation
tomkerkhove Feb 24, 2023
14f7545
Add replacement
tomkerkhove Feb 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion DEPRECATIONS.md
View file
Open in desktop
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.