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

✨ (go/v4): enable 'import-shadowing' linter #4700

Merged

Conversation

kersten
Copy link
Contributor

@kersten kersten commented Mar 27, 2025

Summary

This PR adds the import-shadowing linter to all .golangci.yml configuration files across test projects and templates.
The import-shadowing linter detects cases where a package import shadows an existing variable, which can lead to subtle bugs.

Motivation

Adding this linter helps maintain cleaner and more maintainable code by avoiding accidental name collisions.
This change aligns the lint configuration across the codebase and ensures new code follows the same checks.

Changes

  • Added import-shadowing to:
    • testdata/project-v4*/.golangci.yml
    • test projects in docs/book/src/**/testdata
    • generated linter config in pkg/plugins/golang/v4/scaffolds/internal/templates/golangci.go

No functional code changes were made—this is purely a tooling/linting update.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Mar 27, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @kersten. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 27, 2025
This PR adds the `import-shadowing` linter to all `.golangci.yml` configuration files across test projects and templates.
The `import-shadowing` linter detects cases where a package import shadows an existing variable, which can lead to subtle bugs.
@kersten kersten force-pushed the chore/add-import-shadowing-linter branch from f3b5ace to 9eae3eb Compare March 28, 2025 05:46
@camilamacedo86
Copy link
Member

camilamacedo86 commented Mar 28, 2025

This one is an addition so the best, here would be ✨ ( new feature .. add a new linter )
So, I hope that you do not mind, but I have updated the title accordingly.

@camilamacedo86 camilamacedo86 changed the title 🐛 enable 'import-shadowing' linter in .golangci.yml files ✨ (go/v4): enable 'import-shadowing' linter Mar 28, 2025
@camilamacedo86
Copy link
Member

/ok-to-test
/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 28, 2025
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 28, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, kersten

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 Mar 28, 2025
@k8s-ci-robot k8s-ci-robot merged commit b9b5d5c into kubernetes-sigs:master Mar 28, 2025
34 checks passed
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. 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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants