Extend report of deprecated object usage with possible remove date
Opened this issue · 5 comments
ref OAMG-3757
Add to the deprecation report the note that the functionality is deprecated since .... and it might be removed in 6 month
State before (example):
----------------------------------------
Risk Factor: medium
Title: Usage of deprecated Model "TMPTargetRepositoriesFacts" at /usr/lib/python2.7/site-packages/leapp/models/__init__.py:113
Summary: The model is temporary and not assumed to be used in any other actors.
Since: 2020-09-01
Location: /usr/lib/python2.7/site-packages/leapp/models/__init__.py:113
Near: return cls(init_method='to_model', **data)
----------------------------------------
State after:
----------------------------------------
Risk Factor: medium
Title: Usage of deprecated Model "TMPTargetRepositoriesFacts" at /usr/lib/python2.7/site-packages/leapp/models/__init__.py:113
Summary: The model is temporary and not assumed to be used in any other actors.
Deprecated since: 2020-09-01
May get removed after: 2021-03-01
Location: /usr/lib/python2.7/site-packages/leapp/models/__init__.py:113
Near: return cls(init_method='to_model', **data)
----------------------------------------
Possible remove since: 2021-03-01 sounds strange.
I'd write:
Deprecated since: 2020-09-01
May get removed after: 2021-03-01
It looks little inconsistent: Since and Possible remove since. As well, from the previous discussion (maybe with @vinzenz ?) we concluded it could be more confusing for people. They are really supposed to read the documentation about the deprecation. Putting there the possible remove (again without reading documentation) could lead to point that people will panic.
E.g.: we deprecate something on 2020-03-01, we do release on 2020-07-01. Does it mean we remove the stuf on 2020-09-01? no. we will probably keep it in the way that it will dissapear in 2021-02-01 in earliest from the user POV.
"They are really supposed to read the documentation about the deprecation." No, please no :)
"Putting there the possible remove (again without reading documentation) could lead to point that people will panic." - I proposed adding the date after which the entity could get removed on Cabal and there was no voice against.
I don't see why should anyone panic. Above, I suggested rewording it to "May get removed after: ". The word "may" is the key here.
In the example you mention (we deprecate something on 2020-03-01, we do release on 2020-07-01), we may release leapp asynchronously on 2020-08-08 and in that release, the deprecated entity can be gone.
"Putting there the possible remove (again without reading documentation) could lead to point that people will panic." - I proposed adding the date after which the entity could get removed on Cabal and there was no voice against.
No problem then.