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

🌱 golangci: add comments to enabled linters #11142

Merged
merged 1 commit into from
Sep 9, 2024

Conversation

schrej
Copy link
Member

@schrej schrej commented Sep 5, 2024

What this PR does / why we need it:
We're using an adapted version of CAPI's golangci-lint config. I've recently updated the linter list with comments summarising what each linter does, since it's quite cumbersome to look it up in case you want to know.
This should also make it easier for other projects to adopt this configuration.

I've also removed two linters:

  • typecheck - it's no longer listed in the documentation
  • rowserrcheck - it's for the sql package, and I hope we're not using that anywhere

I also removed one deprecated parameter and moved file exclusions to the new location.

/area ci

also fixes some deprecations
@k8s-ci-robot k8s-ci-robot added area/ci Issues or PRs related to ci cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 5, 2024
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 5, 2024
Copy link
Member

@sivchari sivchari left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks :)
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 6, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: b842ae39d993eb72752e51a09e82da38b738ab04

@@ -4,62 +4,55 @@ run:
build-tags:
- tools
- e2e
skip-files:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should write this configuration in issues section. It's good modification.

@@ -187,7 +180,6 @@ linters-settings:
alias: infraexpv1
nolintlint:
allow-unused: false
allow-leading-space: false
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's okay due to this field isn't existing.

@sivchari
Copy link
Member

sivchari commented Sep 6, 2024

Maybe, this PR is part of #11132 .

@schrej
Copy link
Member Author

schrej commented Sep 6, 2024

Maybe, this PR is part of #11132 .

I can rebase once that's merged. This one is primarily about the linter descriptions.

@fabriziopandini
Copy link
Member

nice to have comments near each linter, I will take a look to other changes ASAP

Copy link
Member

@chrischdi chrischdi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@fabriziopandini
Copy link
Member

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 9, 2024
@k8s-ci-robot k8s-ci-robot merged commit a8ae016 into kubernetes-sigs:main Sep 9, 2024
24 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.9 milestone Sep 9, 2024
@schrej schrej deleted the golangci-comments branch September 9, 2024 11:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/ci Issues or PRs related to ci cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants