opencensus-java icon indicating copy to clipboard operation
opencensus-java copied to clipboard

Consider using tools to check backward compatibility.

Open HailongWen opened this issue 7 years ago • 3 comments

This is a part of #858, which introduces some API changes that might break backward compatibility. Besides code review, we need something more automated.

Currently I am looking at JAPICC but haven't figure out whether to it is useful and should be included in the project. The discussion is left open.

HailongWen avatar Feb 08 '18 00:02 HailongWen

I've tried the tool and it can generate a general useful report for the compatibility. See examples here. It does generate a score to evaluate compatibility between different version of jars, as well as detailed information (severity, possible effects) on each affected API. However it might generate false-positive result on AutoValue class change.

It is nice to have individually but I don't think it should be enforced as a team-wide tool. Close this issue for now.

HailongWen avatar Feb 09 '18 21:02 HailongWen

I think it would still be useful to mention the tool in RELEASING.md, so that we can manually run it before making a release. That could help us avoid accidentally releasing incompatible changes or help with writing release notes.

sebright2 avatar Feb 12 '18 21:02 sebright2

Sure. Let me check if there are any issues on license.

HailongWen avatar Feb 12 '18 22:02 HailongWen