-
Notifications
You must be signed in to change notification settings - Fork 798
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
Docs: add recommendations on how to deprecate code #16433
Conversation
Thank you for the great PR description! When this PR is ready for review, please apply the E2E results is available here (for debugging purposes): https://jetpack-e2e-dashboard.herokuapp.com/pr-16433 Scheduled Jetpack release: August 4, 2020. |
Thanks! Nice addition. Is there some timeline where we are comfortable removing deprecated code? Like after X months? If we have this rule set, we could push for deprecation notices to include a message about when this will be fully removed. Though we technically only support the last 2 versions of Jetpack, we know in practice that it often takes people longer than that to modify their code. I think a 6 month deprecation would be pretty generous, and reasonable. Then if we have that rule, we could set up a parser to check for them periodically. Thoughts? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just noticed the bullet point about the 6 months!
d834396
to
cd7a0a0
Compare
In #16433, we determined that we would remove deprecated files and functions 6 months after they've been deprecated. Let's communicate this to site owners as well, by outputting additional details in the error logs when a deprecation notice is issued.
Took a stab at this in #16444. |
I like that idea. I am not sure how to best go about it though. I suppose we could make it a habit for the release lead at the beginning of each release cycle? |
Following #16433, let's remove all code that was deprecated more than 6 months ago.
Following #16433, let's remove all code that was deprecated more than 6 months ago.
Following #16433, let's remove all code that was deprecated more than 6 months ago. This commit also standardizes some of the version numbers so they can start getting the proper notices, and we can then remove the deprecations in the future. Note that "6 months" here refers to 6 months as of the last time this PR was updated, in December 2020.
Changes proposed in this Pull Request:
cc'ing @dereksmart on this, since you've often been our champion for removing deprecated code. Previous art on the topic:
Note: I also took the opportunity to update wording in another document, moving from Master issue to Primary issue (see #16099).
Jetpack product discussion
Does this pull request change what data or activity we track or use?
Testing instructions:
Proposed changelog entry for your changes: