Include golangci-lint in fmt Make target #1672
Open
+3
−2
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
shuheiktgw
commented
Feb 8, 2025
| @@ -306,7 +307,7 @@ patch-crds: bin/$(PLATFORM)/yq ## Patch-crds | |||
| hack/patch-crds.sh | |||
|
|
|||
| .PHONY: lint | |||
| lint: bin/$(PLATFORM)/golangci-lint fmt vet ## Lint | |||
There was a problem hiding this comment.
I believe we should not include the fmt target in the lint target. Consider the following two cases:
- A user makes local commits and runs the lint target for a final check. Even if there are lint failures, the fmt target fixes them automatically, causing the lint target to succeed despite local diffs. As a result, the user may push the commit without realizing there are uncommitted changes.
- In CI, make lint runs, and even if there are lint failures, the fmt target fixes them. This could cause the CI job to pass mistakenly, despite the issues.
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.
What does this PR do?
Currently, there's no easy way to run
golangci-lint run ./... --fixfor formatting. It would be more convenient and intuitive if we could execute it via the fmt Make target.Thanks for your review!
Motivation
Running
golangci-lint run ./... --fixeasier.Checklist
bug,enhancement,refactoring,documentation,tooling, and/ordependenciesqa/skip-qalabel