Skip to content

chore: prep release 1.5.0 #345

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

Merged
merged 1 commit into from
Mar 31, 2021
Merged

chore: prep release 1.5.0 #345

merged 1 commit into from
Mar 31, 2021

Conversation

pankajagrawal16
Copy link
Contributor

@pankajagrawal16 pankajagrawal16 commented Mar 30, 2021

Issue #, if available:

Description of changes:

Checklist

Breaking change checklist

RFC issue #:

  • Migration process documented
  • Implement warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@pankajagrawal16 pankajagrawal16 requested a review from msailes March 30, 2021 10:49
msailes
msailes previously approved these changes Mar 30, 2021
Copy link
Contributor

@msailes msailes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

CHANGELOG.md Outdated
@@ -8,8 +8,22 @@ This project follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) fo

## [Unreleased]

## [1.5.0] - 2021-03-30

* **Tracing**: Removed deprecated attributes on `Tracing` annotation. If you are still using `captureResponse` and `captureError`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't that a major update?

What's the cost in keeping both but leaving only one documented?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's how we deprecated it initially by removing its reference from our docs. So docs don't have these attributes referenced. It won't lead to any surprises functionally, since this will lead to a compile time error for users.

Cost of keeping deprecated attribute forever is basically technical debt.

@heitorlessa
Copy link
Contributor

heitorlessa commented Mar 30, 2021 via email

@pankajagrawal16
Copy link
Contributor Author

Forever is a long time. you can cut a major release :) If all of you are fine with the decision (I wouldn’t), then please make sure this is called out in the release notes too

On Tue, 30 Mar 2021 at 12:57, Pankaj Agrawal @.> wrote: @.* commented on this pull request. ------------------------------ In CHANGELOG.md <#345 (comment)> : > @@ -8,8 +8,22 @@ This project follows Keep a Changelog fo ## [Unreleased] +## [1.5.0] - 2021-03-30 + +* Tracing: Removed deprecated attributes on Tracing annotation. If you are still using captureResponse and captureError That's how we deprecated it initially by removing its reference from our docs. So docs don't have these attributes referenced. It won't lead to any surprises functionally, since this will lead to a compile time error for users. Cost of keeping deprecated attribute forever is basically technical debt. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#345 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAZPQBDKBBQDV3DWBQ7N7M3TGGVCBANCNFSM42BYLYRA .

Its no problem to cut a major release as well. Or maybe we can wait with the removal change until we really need to make a major release. Thoughts @msailes ?

@heitorlessa
Copy link
Contributor

heitorlessa commented Mar 30, 2021 via email

@pankajagrawal16
Copy link
Contributor Author

pankajagrawal16 commented Mar 30, 2021

If that helps, for Python at least, we’re gonna start publishing our list of tech debts we want to cut in 2.0. I’ll ping once it’s public hopefully next week.

I am thinking maybe that's best way to solve it. Which means we can target more deprecated features as part of a single major release rather than bumping major release each time we remove a deperecated feature.

@pankajagrawal16
Copy link
Contributor Author

@heitorlessa / @msailes Looks better?

Copy link
Contributor

@heitorlessa heitorlessa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for taking breaking changes into account. I'm sure customers will appreciate that.

@pankajagrawal16 pankajagrawal16 merged commit 0db2903 into master Mar 31, 2021
@pankajagrawal16 pankajagrawal16 deleted the prep-release-1.5.0 branch March 31, 2021 06:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants