Skip to content
This repository has been archived by the owner on May 23, 2023. It is now read-only.

You're breaking the public API too often. #100

Closed
peterbourgon opened this issue Jul 18, 2016 · 3 comments
Closed

You're breaking the public API too often. #100

peterbourgon opened this issue Jul 18, 2016 · 3 comments

Comments

@peterbourgon
Copy link

peterbourgon commented Jul 18, 2016

About every week, I or one of my contributors has to submit a (sometimes large) patch to Go kit to get our continuous integration working again, after OpenTracing changes its public API. Here is the most recent example I noticed today. Can you please make an effort to reduce the number of breaking changes you make to exported types and method sets? Thank you!

@bhs
Copy link
Contributor

bhs commented Jul 18, 2016

@peterbourgon FWIW, on May 2 you wrote:

... And for the record Go kit has no problem with API breakage; all of our consumers are vendoring.

I had remembered the above and kept it in mind as a consideration... since we're about to add direct dependencies from gRPC, I wanted to make any planned breaking changes ASAP.

The consolation here is that there are only a few more issues before we declare OT 1.0 and make backwards-compatibility more of a priority: https://github.com/opentracing/opentracing.github.io/milestone/2

Of those, only opentracing/opentracing.io#106 will introduce breaking changes (though that one will not affect go-kit since it doesn't use Baggage). The KV logging will deprecate the older logging methods, but I don't think we'll remove them just yet.

In any case, as an olive branch I will make sure to prepare go-kit PRs in tandem with any remaining breaking OT-go changes. I think we're mostly out of the woods, though.

Sorry for the trouble.

@peterbourgon
Copy link
Author

Yep, in retrospect this came across a little strong, which I apologize for. In the end breaking changes are just annoying to me :) so it's not a terrible thing, no users are complaining or anything. Just wanted to provide a bit of signal that it is being noticed. Take whatever action you deem appropriate. And thanks again for the great work!

@bhs
Copy link
Contributor

bhs commented Jul 19, 2016

@peterbourgon absolutely no reason to apologize -- breaking changes are incredibly annoying. I reiterate my offer to help with any breaking in go-kit resulting from OT-go changes (though admittedly I don't anticipate any :)

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

No branches or pull requests

2 participants