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.

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

Extend report of deprecated object usage with possible remove date #657

Open
zhukovgreen opened this issue Aug 11, 2020 · 5 comments
Open

Comments

@zhukovgreen
Copy link
Contributor

zhukovgreen commented Aug 11, 2020

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)

----------------------------------------
@zhukovgreen zhukovgreen changed the title Add to deprecation report the note about when we will remove the functionality Extend report of deprecated object usage with possible remove date Aug 11, 2020
@zhukovgreen
Copy link
Contributor Author

@bocekm @vinzenz @pirat89 any wishes to the description of the ticket?

@bocekm
Copy link
Member

bocekm commented Aug 11, 2020

Possible remove since: 2021-03-01 sounds strange.

I'd write:

Deprecated since: 2020-09-01
May get removed after: 2021-03-01

@pirat89
Copy link
Member

pirat89 commented Aug 11, 2020

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.

@bocekm
Copy link
Member

bocekm commented Aug 11, 2020

"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.

@pirat89
Copy link
Member

pirat89 commented Aug 11, 2020

"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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants