diff options
Diffstat (limited to 'releasenotes/notes/add-deprecated-metadata-to-DeprecatedRule-79d2e8a3f5d11743.yaml')
| -rw-r--r-- | releasenotes/notes/add-deprecated-metadata-to-DeprecatedRule-79d2e8a3f5d11743.yaml | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/releasenotes/notes/add-deprecated-metadata-to-DeprecatedRule-79d2e8a3f5d11743.yaml b/releasenotes/notes/add-deprecated-metadata-to-DeprecatedRule-79d2e8a3f5d11743.yaml new file mode 100644 index 0000000..4d5c484 --- /dev/null +++ b/releasenotes/notes/add-deprecated-metadata-to-DeprecatedRule-79d2e8a3f5d11743.yaml @@ -0,0 +1,12 @@ +--- +features: + - | + ``DeprecatedRule`` now accepts two new parameters: ``deprecated_reason`` + and ``deprecated_since``. These should be used in place of the equivalent + parameters on the rule that is replacing this rule in order to avoid + confusion. +upgrade: + - | + Users with a ``RuleDefault`` or ``DocumentedRuleDefault`` that have + configured a ``deprecated_rule`` should move the ``deprecated_reason`` + and ``deprecated_since`` parameters to this ``DeprecatedRule``. |