Add External Type Checking #1603
Merged
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
The purpose of this is to ensure we understand the API surface area. Anything exposed by a crate like a type can affect the possible compatibility. This means that if we bump an external type it could cause breaking changes. This tracks them to limit this possibility. Affected Crates: - opentelemetry-otlp - opentelemetry-zipkin
lalitb
reviewed
Mar 6, 2024
| @@ -0,0 +1,22 @@ | |||
| # Copyright The OpenTelemetry Authors | |||
There was a problem hiding this comment.
(sorry to nit pick) - Not related to this PR, we don't include copyright/license headers in individual files, we have the LICENSE file in each crate, and also license information in crates.toml. I noticed that the header is present in other allowed-external-types.toml's too, which seems like something we should address in a separate cleanup :)
lalitb
approved these changes
Mar 6, 2024
TommyCpp
approved these changes
Mar 8, 2024
To my knowledge the tool only supports a per crate configuration ot workspace level. |
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.
The purpose of this is to ensure we understand the API surface area. Anything exposed by a crate like a type can affect the possible compatibility. This means that if we bump an external type it could cause breaking changes. This tracks them to limit this possibility.
Affected Crates:
Fixes #
Design discussion issue (if applicable) #
Changes
Please provide a brief description of the changes here.
Merge requirement checklist
CHANGELOG.mdfiles updated for non-trivial, user-facing changes