Merge pull request #248 from sapcc/golangci-lint-timeout-option

make timeout for golangci-lint configurable

Author: SuperSandro2000

.github/workflows/checks.yaml

@@ -33,6 +33,7 @@ jobs:
       - name: Run golangci-lint
         uses: golangci/golangci-lint-action@v6
         with:
+          verify: false
           version: latest
       - name: Dependency Licenses Review
         run: make check-dependency-licenses

.golangci.yaml

@@ -7,7 +7,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 run:
-  timeout: 3m # 1m by default
+  timeout: 3m0s # 1m by default
   modules-download-mode: vendor
 
 output:

internal/core/config.go

@@ -6,6 +6,7 @@ package core
 import (
 	"os/exec"
 	"strings"
+	"time"
 
 	"github.com/sapcc/go-bits/logg"
 )
@@ -90,9 +91,10 @@ type GolangConfiguration struct {
 
 // GolangciLintConfiguration appears in type Configuration.
 type GolangciLintConfiguration struct {
-	CreateConfig     bool     `yaml:"createConfig"`
-	ErrcheckExcludes []string `yaml:"errcheckExcludes"`
-	SkipDirs         []string `yaml:"skipDirs"`
+	CreateConfig     bool          `yaml:"createConfig"`
+	ErrcheckExcludes []string      `yaml:"errcheckExcludes"`
+	SkipDirs         []string      `yaml:"skipDirs"`
+	Timeout          time.Duration `yaml:"timeout"`
 }
 
 type GoReleaserConfiguration struct {

internal/ghworkflow/workflow_checks.go

@@ -23,6 +23,8 @@ func checksWorkflow(cfg core.Configuration) {
 		Name: "Run golangci-lint",
 		Uses: core.GolangciLintAction,
 		With: map[string]any{
+			// disabled until https://github.com/golangci/golangci-lint/pull/5501 is resolved
+			"verify":  false,
 			"version": "latest",
 		},
 	})

internal/golangcilint/golangci_lint.go

@@ -9,6 +9,7 @@ import (
 	"strconv"
 	"strings"
 	"text/template"
+	"time"
 
 	"github.com/sapcc/go-bits/must"
 
@@ -18,7 +19,7 @@ import (
 
 var configTmpl = template.Must(template.New("golangci").Parse(strings.TrimSpace(strings.ReplaceAll(`
 run:
-	timeout: 3m # 1m by default
+	timeout: {{ .Timeout }} # 1m by default
 	modules-download-mode: {{ .ModDownloadMode }}
 
 output:
@@ -215,6 +216,7 @@ type configTmplData struct {
 	MisspellIgnoreWords []string
 	ErrcheckExcludes    []string
 	SkipDirs            []string
+	Timeout             time.Duration
 }
 
 func RenderConfig(cfg core.Configuration, sr golang.ScanResult) {
@@ -223,6 +225,11 @@ func RenderConfig(cfg core.Configuration, sr golang.ScanResult) {
 		mode = "vendor"
 	}
 
+	timeout := 3 * time.Minute
+	if cfg.GolangciLint.Timeout != 0 {
+		timeout = cfg.GolangciLint.Timeout
+	}
+
 	f := must.Return(os.Create(".golangci.yaml"))
 	fmt.Fprintln(f, core.AutogeneratedHeader+"\n")
 	must.Succeed(configTmpl.Execute(f, configTmplData{
@@ -232,6 +239,7 @@ func RenderConfig(cfg core.Configuration, sr golang.ScanResult) {
 		MisspellIgnoreWords: cfg.SpellCheck.IgnoreWords,
 		ErrcheckExcludes:    cfg.GolangciLint.ErrcheckExcludes,
 		SkipDirs:            cfg.GolangciLint.SkipDirs,
+		Timeout:             timeout,
 	}))
 	fmt.Fprintln(f) // empty line at end