Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add linting #73

Closed
3 tasks done
skriss opened this issue May 25, 2022 · 6 comments
Closed
3 tasks done

add linting #73

skriss opened this issue May 25, 2022 · 6 comments
Assignees
Labels
area/ci CI and build related issues good first issue Good for newcomers help wanted Extra attention is needed
Milestone

Comments

@skriss
Copy link
Contributor

skriss commented May 25, 2022

Linting should be added to the project. Ideally it can be run both locally by developers, via a make task, and in GitHub Actions.

Suggested tools:

  • golangci-lint for Go
  • yamlllint for YAML
  • codespell (TODO golangci-lint has misspell; is that sufficient?)
@skriss skriss added this to the 0.2.0 milestone May 25, 2022
@danehans danehans added good first issue Good for newcomers help wanted Extra attention is needed area/ci CI and build related issues labels May 25, 2022
@vince-0202
Copy link

Are we going to use Go 1.18?
There seem to be some unresolved issues regarding golangci-lint support for Go1.18.
golangci/golangci-lint#2649

@danehans
Copy link
Contributor

danehans commented May 26, 2022

@vince-0202 thanks for making us aware of the golangci-lint issue. We currently plan on using 1.18.2, so the golangci-lint portion of this issue is blocked until golangci/golangci-lint#2649 is fixed or if we decide to use 1.17.x instead.

xref: https://github.com/envoyproxy/gateway/pull/72/files#diff-868425f4c6dd9927d83974d334ea46b9ec96854cdac9bb15b15f43bc4ad17820R6

@lianghao208
Copy link
Contributor

so the golangci-lint portion of this issue is blocked until golangci/golangci-lint#2649 is fixed or if we decide to use 1.17.x instead.

/assign

I think we should wait until golangci/golangci-lint#2649 has been fixed.

@danehans
Copy link
Contributor

@lianghao208 feel free to assign yourself the issue if you would like to work on it. I suggest using Contour as reference model as I believe it has implemented these linters.

@lianghao208
Copy link
Contributor

lianghao208 commented May 28, 2022

I suggest using Contour as reference model as I believe it has implemented these linters.

@danehans Thanks for the suggestion, I've added linters referring to the Contour.

@danehans
Copy link
Contributor

danehans commented Aug 2, 2022

Closing as all linters have been added.

@danehans danehans closed this as completed Aug 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ci CI and build related issues good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants