Skip to content

🌱: introduce gci as formatter in golangci-lint #4927

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

Merged

Conversation

bavarianbidi
Copy link
Contributor

To have a common appearance of the import section, gci as formatter is enforcing the following pattern of imports:

    gci:
      sections:
        - standard
        - default
        - prefix(sigs.k8s.io/kubebuilder)
        - dot

xref: gci documentation - https://golangci-lint.run/usage/formatters/#gci

This is a follow-up task by a PR comment in #4914

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 15, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @bavarianbidi. 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 needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 15, 2025
Copy link

@mateusoliveira43 mateusoliveira43 left a comment

Choose a reason for hiding this comment

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

should we also add to scaffolded config?

@bavarianbidi
Copy link
Contributor Author

should we also add to scaffolded config?

I like the idea, but as we already use different formatter/linter-config, I wasn't sure about when to extend the skaffolding files:

formatters in the project scaffolding (xref: skaffolding golangci.yaml)

formatters:
  enable:
    - gofmt
    - goimports

formatters in the kubebuilder golangci.yaml config xref: kubebuilder golangci yaml

formatters:
  enable:
    - gci
    - gofmt
    - gofumpt
    - goimports

@camilamacedo86
Copy link
Member

I like the idea, but as we already use different formatter/linter-config, I wasn't sure about when to extend the skaffolding files:

It's a good idea to see if there are things we can improve upon.
I would love get your help with
But we need one PR for each new one added there since we will need to change the scaffold

Copy link
Member

@camilamacedo86 camilamacedo86 left a comment

Choose a reason for hiding this comment

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

/lgtm

Thank you 🥇

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bavarianbidi, camilamacedo86, mateusoliveira43

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 Jul 17, 2025
to enforce import sections

Signed-off-by: Mario Constanti <[email protected]>
@bavarianbidi bavarianbidi force-pushed the enable_gci_formater branch from d90b40d to 728a3b0 Compare July 17, 2025 06:24
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 17, 2025
@camilamacedo86
Copy link
Member

/ok-to-test
/lgtm

@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. lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 17, 2025
@k8s-ci-robot k8s-ci-robot merged commit e522ae5 into kubernetes-sigs:master Jul 17, 2025
23 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/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.

4 participants