Add STABLE_PACKAGE_NO_IMPORT_UNSTABLE lint rule #3010
Merged
Conversation
This file contains hidden or 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
bufdev
changed the title
akshayjshah
reviewed
May 23, 2024
| continue | ||
| } | ||
| if packageVersion.StabilityLevel() != protoversion.StabilityLevelStable { | ||
| add(fileImport, fileImport.Location(), nil, `This file has package %q that represents a stable version, but it imports %q, which has package %q that represents an unstable version. Stable packages should not depend on unstable packages.`, file.Package(), fileImport.Import(), fileImport.File().Package()) |
There was a problem hiding this comment.
Can we shorten the error text?
This file is in stable package %q, so it should not depend on %q from unstable package %q.
There was a problem hiding this comment.
I'm just doc golfing but less text is always nice, e.g. Stable package %q cannot import unstable file %q.
doriable
changed the title
|
The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).
|
bufdev
commented
Aug 12, 2024
|
|
||
| package api.v1; | ||
|
|
||
| import "api/v1alpha/bar.proto"; |
There was a problem hiding this comment.
An import on a stable package, and a package with no stability level, should also be added (both should not result in failures)
bufdev
commented
Aug 12, 2024
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.
I'm not yet sure if we want to add this into mainline. Opening this for discussion.
This is re: #2986.
This adds a
STABLE_PACKAGE_NO_IMPORT_UNSTABLElint rule, with no category, that will produce a lint failure if an stable package imports a file with an unstable package. For example:a.protoimportsb.proto, anda.protohas packagea.v1:b.protohas packagefoo, no failure - cannot determine package stability.b.protohas packagefoo.v1, no failure - stable imports stable.b.protohas packagefoo.v1beta1, failure - stable imports unstable.a.protohas packagea:a.protohas packagea.v1beta1:If we do decide to go ahead with this, this PR: