✨ Enforce go import order via gci linter #5592
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
k8s-ci-robot
added
do-not-merge/work-in-progress
k8s-ci-robot
added
the
size/XXL
sbueringer
changed the title
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
|
/cc @stmcginnis (next try :)) |
killianmuldoon
approved these changes
Nov 5, 2021
k8s-ci-robot
added
the
lgtm
|
Thanks for this! Definitely going to be a big help on PRs 😄 |
sbueringer
force-pushed
the
pr-enable-gci-linter
branch
from
4f25fb1
to
5fd8ecf
Compare
k8s-ci-robot
removed
the
lgtm
vincepri
reviewed
Nov 8, 2021
.golangci.yml
Outdated
Comment on lines
46
to
47
| gci: | ||
| local-prefixes: sigs.k8s.io/cluster-api |
There was a problem hiding this comment.
Can we use no local prefixes? Most folks out there with goimports won't necessarily make use of it and we can reduce some friction here
k8s-ci-robot
added
the
needs-rebase
sbueringer
force-pushed
the
pr-enable-gci-linter
branch
from
5fd8ecf
to
32cee53
Compare
k8s-ci-robot
added
size/L
Signed-off-by: Stefan Büringer buringerst@vmware.com
sbueringer
force-pushed
the
pr-enable-gci-linter
branch
from
32cee53
to
ec1fa65
Compare
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: vincepri The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
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.
Signed-off-by: Stefan Büringer buringerst@vmware.com
What this PR does / why we need it:
The GCI linter is essentially an improved (imho) version of goimports, which is also compatible with goimports, i.e. gci results in an import format which is compatible to what goimports enforces. (just a bit more strict)
With the configuration in this PR it sorts the imports in this order: (we could merge the second and third block if we want)
I think this would help reviewers and contributors by just enforcing the right import order this way. gci supports
make lint-fixso nobody has to sort the imports manually after e.g. Intellij added them arbitrarily.The current situation where we are not linting it automatically but manually on PRs does not seem like an ideal situation and requires additional effort from reviewers and contributors.
P.S. The changes in this PR are a result of the changes in the golang-ci config + running
make lint-fix.xref: #5585 (comment)
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #