Parse lint and breaking ignore paths in buf.yaml v2 #2661
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
…ne about v1beta1: are those paths relative to the module root or build root in v1beta1?
oliversun9
commented
Dec 13, 2023
| if err != nil { | ||
| return nil, err | ||
| } | ||
| // TODO: we do no validation of paths now |
There was a problem hiding this comment.
This TODO is left as-is: in bufcheck/internal, newConfigForRuleBuilders does validation for these paths, which is also the behavior on main. Note that newConfigForRuleBuilders is called only for buf lint or buf breaking.
One interesting implication is that a user can have a semi-invalid buf.yaml (a file with the correct shape but invalid ignore paths) and they can successfully run buf build but not buf lint. I verified that this is the case with main. (The easiest way to try this out is to add "." to ignore and run buf build and buf lint)
bufdev
approved these changes
Dec 13, 2023
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.
In buf.yaml v2, we want paths for
ignoreandignore_onlyinlintandbreakingto be relative to the workspace root, but paths in aCheckConfigshould be relative to module roots, i.e. they are import paths. This PR adds this transformation for read and write.