Enable generation and comparison of public API snapshots #3081
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tigrannajaryan
approved these changes
May 7, 2021
There was a problem hiding this comment.
LGTM. Thanks @Aneurysm9
@bogdandrutu I think this will be very useful to prevent breaking changes once we GA.
|
@Aneurysm9 friendly ping :) |
Signed-off-by: Anthony J Mirabella <[email protected]>
Signed-off-by: Anthony J Mirabella <[email protected]>
bogdandrutu
approved these changes
May 10, 2021
dashpole
pushed a commit
to dashpole/opentelemetry-collector
that referenced
this pull request
Jun 14, 2021
…try#3081) * Add `apidiff` to internal/tools * Add Makefile target for building apidiff snapshots * Add Makefile target for comparing API snapshots * Update apidiff comparison to only output when changes are detected * Fix missing newline at end of Makefile Signed-off-by: Anthony J Mirabella <[email protected]> * Tidy mods in internal/tools Signed-off-by: Anthony J Mirabella <[email protected]>
ankitnayan
pushed a commit
to SigNoz/opentelemetry-collector
that referenced
this pull request
Jul 27, 2021
…try#3081) * Add `apidiff` to internal/tools * Add Makefile target for building apidiff snapshots * Add Makefile target for comparing API snapshots * Update apidiff comparison to only output when changes are detected * Fix missing newline at end of Makefile Signed-off-by: Anthony J Mirabella <[email protected]> * Tidy mods in internal/tools Signed-off-by: Anthony J Mirabella <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description: This adds some
Makefiletargets that use theapidifftool to generate and compare public API snapshots. These comparisons can be used to detect whether breaking changes have been introduced or when new public API surface is added.Link to tracking Issue: #2545
Testing: A snapshot was created from the
v0.25.0release and compared against the currentHEAD:Click to expand!
Documentation: No documentation is added other than usage output for the new internal scripts as this is intended to be used in CI or during the release process. The precise mechanisms and timing for creating and comparing public API snapshots need to be determined and appropriate maintainer-facing documentation can be created at that time, if appropriate.