Add go linting to CI config #2018
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
Signed-off-by: Kevin Lingerfelt <kl@buoyant.io>
Signed-off-by: Kevin Lingerfelt <kl@buoyant.io>
|
CI passed 🎉 -- this is now ready for review. |
siggy
approved these changes
Dec 20, 2018
| go install ./vendor/golang.org/x/lint/golint | ||
|
|
||
| # use `go list` to exclude packages in vendor, ignore uncommented warnings | ||
| out=$(go list ./... | xargs golint | grep -v 'should have comment') || true |
There was a problem hiding this comment.
An alternative to this would be to use golangci-lint run --disable-all -E golint - this ignores all comment related linter errors, and in the future we could enable even more linters by adding a linter config file. If golint is the only one needed, then this is perfect.
There was a problem hiding this comment.
Wow! I had no idea that the go linting rabbit hole goes so deep :)
I wouldn't be opposed to adding additional linting configurations going forward, but I think golint minus comments suffices for our use case right now. That said, I'd happily review a PR that improved upon it. Thanks for the suggestion!
Signed-off-by: Kevin Lingerfelt <kl@buoyant.io>
siggy
added a commit
that referenced
this pull request
Jan 2, 2019
Commit 1: Enable lint check for comments Part of #217. Follow up from #1982 and #2018. A subsequent commit will fix the ci failure. Commit 2: Address all comment-related linter errors. This change addresses all comment-related linter errors by doing the following: - Add comments to exported symbols - Make some exported symbols private - Recommend via TODOs that some exported symbols should should move or be removed This PR does not: - Modify, move, or remove any code - Modify existing comments Signed-off-by: Andrew Seigner <siggy@buoyant.io>
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.
This branch starts running golint on every CI build. I'm expecting this PR to fail CI with 8 lint warning, which I'll clean up in a subsequent commit. This is a follow-up to #1982.