Skip to content

golangci: migrate to v2 schema #4712

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

sebrandon1
Copy link
Contributor

@sebrandon1 sebrandon1 commented Apr 1, 2025

Utilize the golangci-lint migrate command to migrate the config over to the v2 schema.

Note: I disabled the revive linter because it was flagging the dot-imports for ginkgo and gomega.

Similar to: redhat-best-practices-for-k8s/certsuite#2875

Summary by Sourcery

Migrate golangci-lint configuration to version 2 schema, updating linter settings and configuration structure

Bug Fixes:

  • Temporarily disable revive linter to avoid false positives with dot imports in test frameworks

Enhancements:

  • Refactor linter configuration to use more structured exclusion rules
  • Improve linter and formatter configuration with preset exclusions

Chores:

  • Update golangci-lint configuration to use v2 schema with improved linter organization

Copy link

sourcery-ai bot commented Apr 1, 2025

Reviewer's Guide by Sourcery

This pull request migrates the golangci-lint configuration to the v2 schema and disables the revive linter due to dot-import conflicts. The configuration structure has been reorganized, and issue filtering has been updated for more flexibility.

Updated class diagram for golangci-lint configuration

classDiagram
  class GolangCIConfigV1 {
    build-tags: string[]
    timeout: string
    enable: string[]
    exclude-rules: string[]
  }
  note for GolangCIConfigV1 "Represents the v1 version of the golangci-lint configuration"

  class GolangCIConfigV2 {
    version: string
    run: RunConfig
    linters: LintersConfig
    issues: IssuesConfig
    formatters: FormattersConfig
  }
  note for GolangCIConfigV2 "Represents the v2 version of the golangci-lint configuration"

  class RunConfig {
    build-tags: string[]
  }

  class LintersConfig {
    enable: string[]
    exclusions: ExclusionsConfig
  }

  class IssuesConfig {
    exclude-rules: string[]
  }

  class FormattersConfig {
   enable: string[]
   exclusions: ExclusionsConfig
  }

  class ExclusionsConfig {
    generated: string
    presets: string[]
    paths: string[]
  }

  GolangCIConfigV2 *-- RunConfig : has
  GolangCIConfigV2 *-- LintersConfig : has
  GolangCIConfigV2 *-- IssuesConfig : has
  GolangCIConfigV2 *-- FormattersConfig : has
  LintersConfig *-- ExclusionsConfig : has
  FormattersConfig *-- ExclusionsConfig : has
Loading

File-Level Changes

Change Details Files
Migrated the golangci-lint configuration to the v2 schema.
  • Updated the configuration file to use version: "2".
  • Reorganized the configuration structure to align with the v2 schema.
  • Updated the enable section under linters to explicitly list enabled linters.
  • Replaced exclude-rules with exclusions under issues for more flexible issue filtering.
  • Added formatters section to configure code formatting tools.
.golangci.yml
Disabled the revive linter due to conflicts with dot-imports in test files.
  • Commented out the revive linter in the enable list under linters.
.golangci.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@openshift-ci openshift-ci bot requested review from anjannath and evidolob April 1, 2025 20:32
Copy link

openshift-ci bot commented Apr 1, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign evidolob for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

Copy link

openshift-ci bot commented Apr 1, 2025

Hi @sebrandon1. Thanks for your PR.

I'm waiting for a crc-org 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.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @sebrandon1 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider enabling revive and fixing the dot-imports instead of disabling the linter.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Contributor

@cfergeau cfergeau left a comment

Choose a reason for hiding this comment

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

Thanks for this PR to upgrade to golangci-lint v2!

@praveenkumar
Copy link
Member

Need rebase and also looks like updated revive need some more changes as part of import.

Copy link
Contributor

@cfergeau cfergeau left a comment

Choose a reason for hiding this comment

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

You will also need some changes in the tools directory to fully complete the changes:

diff --git a/tools/dummy.go b/tools/dummy.go
index a58944ffa..cc37744fc 100644
--- a/tools/dummy.go
+++ b/tools/dummy.go
@@ -5,7 +5,7 @@ package buildtools
 
 import (
 	_ "github.com/cfergeau/gomod2rpmdeps/cmd/gomod2rpmdeps"
-	_ "github.com/golangci/golangci-lint/cmd/golangci-lint"
+	_ "github.com/golangci/golangci-lint/v2/cmd/golangci-lint"
 	_ "github.com/randall77/makefat"
 	_ "golang.org/x/tools/cmd/goimports"
 )
diff --git a/tools/tools.mk b/tools/tools.mk
index e324e1a5c..b9b9c407b 100644
--- a/tools/tools.mk
+++ b/tools/tools.mk
@@ -4,7 +4,7 @@ $(TOOLS_BINDIR)/makefat: $(TOOLS_DIR)/go.mod
 	cd $(TOOLS_DIR) && GOBIN="$(TOOLS_BINDIR)" go install github.com/randall77/makefat
 
 $(TOOLS_BINDIR)/golangci-lint: $(TOOLS_DIR)/go.mod
-	cd $(TOOLS_DIR) && GOBIN="$(TOOLS_BINDIR)" go install github.com/golangci/golangci-lint/cmd/golangci-lint
+	cd $(TOOLS_DIR) && GOBIN="$(TOOLS_BINDIR)" go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint
 
 $(TOOLS_BINDIR)/gomod2rpmdeps: $(TOOLS_DIR)/go.mod
 	cd $(TOOLS_DIR) && GOBIN="$(TOOLS_BINDIR)" go install github.com/cfergeau/gomod2rpmdeps/cmd/gomod2rpmdeps

and

$ go get github.com/golangci/golangci-lint/v2
$ go mod tidy
$ go mod vendor

@sebrandon1 sebrandon1 force-pushed the golangci-lint-v2 branch 2 times, most recently from 90aca3e to a0ed3fd Compare April 11, 2025 18:46
@sebrandon1 sebrandon1 force-pushed the golangci-lint-v2 branch 2 times, most recently from ac3707c to 4548093 Compare April 14, 2025 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants