Skip to content

add golangci-lint to pipeline #234

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.

Sign up for GitHub

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
f-leu merged 5 commits into from
Jan 8, 2026
Merged

add golangci-lint to pipeline #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
431f6e6
add golangci-lint to pipeline
f-leu Jan 8, 2026
6f55c77
fix: update golangci-lint workflow for Go 1.24
f-leu Jan 8, 2026
a1ac000
fix: install golangci-lint from source for Go 1.24 compat
f-leu Jan 8, 2026
2c666a2
rename golang-lint to golangci-lint
f-leu Jan 8, 2026
8cff935
fix typo
f-leu Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ By participating in this project, you agree to abide by our [Code of Conduct](.g
- [Pull Request Guidelines](#pull-request-guidelines)
- [Commit Message Guidelines](#commit-message-guidelines)
- [Testing](#testing)
- [Linting](#linting)
- [Documentation](#documentation)
- [Component-Specific Guidelines](#component-specific-guidelines)
- [Backporting Changes](#backporting-changes)
Expand Down Expand Up @@ -70,6 +71,41 @@ We recommend running tests locally to catch issues before opening a PR.

---

## Linting

We use [golangci-lint](https://golangci-lint.run/) to enforce code quality standards. The linter runs automatically on all pull requests and will block merging if issues are found.

### Running the Linter Locally

```bash
# Run linting (will fail on errors)
make lint

# Run linting with auto-fix for fixable issues
make lint-fix
```

### Configuration

Linting rules are configured in `.golangci.yml` at the repository root. The configuration enables these linters:

- **errcheck** - Check for unchecked errors
- **govet** - Report suspicious constructs
- **staticcheck** - Advanced static analysis
- **gofmt/goimports** - Code formatting
- **misspell** - Spelling errors in comments
- **revive** - Extensible linter with many rules
- **unused** - Find unused code
- And more (see `.golangci.yml` for the full list)

### Best Practices

- Run `make lint` before committing to catch issues early
- Use `make lint-fix` to automatically fix formatting issues
- If a lint rule seems incorrect for your use case, discuss it in the PR rather than disabling it

---

## Documentation

Contributions to documentation are highly valued. If you find any documentation gaps or errors:
Expand Down
43 changes: 43 additions & 0 deletions .github/workflows/golangci-lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: golangci-lint

on:
push:
branches:
- main
pull_request:
merge_group:
workflow_dispatch:

permissions:
contents: read
pull-requests: read

jobs:
golangci-lint:
name: golangci-lint
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: "go.mod"
cache: true
Comment thread
coderabbitai[bot] marked this conversation as resolved.

- name: Download dependencies
run: go mod download

- name: Generate code
run: make generate

- name: Run golangci-lint
uses: golangci/golangci-lint-action@v6
with:
# Install from source to match Go 1.24
install-mode: goinstall
version: v1.62.2
args: --timeout=5m
# Show only new issues for PRs
only-new-issues: true
Comment on lines +35 to +43
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Jan 8, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Reconsider only-new-issues for main branch pushes.

Setting only-new-issues: true unconditionally means that when code is pushed to main, existing lint issues will not be reported. This could allow technical debt to accumulate, as issues that slip through PR reviews will never be caught on the main branch.

Consider using conditional logic to enable only-new-issues only for pull requests:

🔧 Suggested conditional configuration 
       - name: Run golangci-lint
         uses: golangci/golangci-lint-action@v6
         with:
           version: v1.59.1
           args: --timeout=5m
           # Use the existing .golangci.yml configuration
           # Show only new issues for PRs
-          only-new-issues: true
+          only-new-issues: ${{ github.event_name == 'pull_request' }}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- name: Run golangci-lint
uses: golangci/golangci-lint-action@v6
with:
version: v1.59.1
args: --timeout=5m
# Use the existing .golangci.yml configuration
# Show only new issues for PRs
only-new-issues: true
- name: Run golangci-lint
uses: golangci/golangci-lint-action@v6
with:
version: v1.59.1
args: --timeout=5m
# Use the existing .golangci.yml configuration
# Show only new issues for PRs
only-new-issues: ${{ github.event_name == 'pull_request' }}
🤖 Prompt for AI Agents 
In @.github/workflows/golang-lint.yml around lines 29 - 36, The workflow step
that runs golangci-lint currently sets only-new-issues: true unconditionally;
change it so the step or the only-new-issues input is only enabled for pull
requests (e.g., use a GitHub Actions condition like if: github.event_name ==
'pull_request' on the "Run golangci-lint" step or set only-new-issues only when
github.event_name == 'pull_request') so that pushes to main run the full lint
report while PRs still show only new issues.

1 change: 0 additions & 1 deletion .golangci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ linters:
enable:
- dupl
- errcheck
- exportloopref
- ginkgolinter
- goconst
- gocyclo
Expand Down
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@ HELMIFY ?= helmify
KUSTOMIZE_VERSION ?= v5.4.3
CONTROLLER_TOOLS_VERSION ?= v0.16.5
ENVTEST_VERSION ?= release-0.19
GOLANGCI_LINT_VERSION ?= v1.59.1
GOLANGCI_LINT_VERSION ?= v1.62.2
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Jan 8, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🌐 Web query:

golangci-lint v1.62.2 release

💡 Result:

golangci-lint v1.62.2 was released on 2024-11-25. Changes: several linter dependency bumps (fatcontext, ginkgolinter, errorlint, iface, revive, testifylint) and a fix to ignore cache error when file not found. [1][2]

Sources:
[1] Golangci-lint changelog (v1.62.2).
[2] NewReleases summary of GitHub release v1.62.2.

🌐 Web query:

golangci-lint Go 1.24 compatibility requirements

💡 Result:

Short answer

  • golangci-lint must be built with a Go toolchain at least as new as the Go language version you want to analyze. In other words, a golangci-lint binary built with Go 1.24 (or newer) is required to fully support projects targeting Go 1.24. [1][2]

What to do

  • Use an official golangci-lint release that was compiled with Go 1.24 (support was added in v1.64.2). [2]
  • Or build golangci-lint yourself with Go 1.24 (go build).
  • If you run a binary built with an older Go (e.g., go1.23), you may get errors like "the Go language version (go1.23) used to build golangci-lint is lower than the targeted Go version (1.24.0)". [3]

Sources

  • golangci-lint FAQ: supported Go versions (supports <= Go version used to compile it). [1]
  • golangci-lint changelog v1 (v1.64.2 added go1.24 support). [2]
  • Example issue showing the mismatch error and recommendation to use a golangci-lint version >= the one built with Go 1.24. [3]

Bump golangci-lint to v1.64.2 or newer for Go 1.24 support.

v1.62.2 does not support Go 1.24. golangci-lint must be built with a Go version at least as new as the target Go version. v1.64.2 is the first version compiled with Go 1.24 support; using v1.62.2 will fail with "the Go language version used to build golangci-lint is lower than the targeted Go version (1.24.0)".

🤖 Prompt for AI Agents 
In @Makefile at line 519, Update the GOLANGCI_LINT_VERSION variable to v1.64.2
(or newer) so the Makefile uses a golangci-lint binary built with Go 1.24
support; specifically change the GOLANGCI_LINT_VERSION definition (symbol
GOLANGCI_LINT_VERSION) from v1.62.2 to v1.64.2 or later and ensure any place
that consumes this variable (e.g., targets that download or install
golangci-lint) will pick up the new version.

HELM_VERSION ?= v3.14.2
YQ_VERSION ?= v4.40.5

Expand Down
Loading