refactor: configure golangci-lint and upgrade github actions (yonahd#246

) * refactor: configure golangci-lint and upgrade github actions * fix: golangci-lint timeout issue
zpxlz · Apr 30, 2024 · 8adabd8 · 8adabd8
1 parent 6ee101a
commit 8adabd8
Show file tree

Hide file tree

Showing 10 changed files with 58 additions and 33 deletions.
diff --git a/.github/workflows/merge-request.yml b/.github/workflows/merge-request.yml
@@ -17,32 +17,27 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v5
         with:
           go-version-file: "go.mod"
 
-      - name: Install dependencies
-        run: go get .
-
-      - name: Vet
-        run: go vet ./...
-
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v4
         with:
           version: latest
-          skip-pkg-cache: true
+          skip-cache: true
 
       - name: Build
-        run: go build -v ./...
+        run: make build
 
       - name: Test
-        run: go test -v ./... -coverprofile=coverage.txt
+        run: make test
 
-      - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v3
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+      - name: Upload coverage reports
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.txt
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -9,21 +9,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v5
         with:
           go-version-file: "go.mod"
 
-      - name: Install goreleaser
-        run: go install github.com/goreleaser/goreleaser@latest
-
       - name: Run goreleaser
-        run: |
-          goreleaser release
+        uses: goreleaser/goreleaser-action@v5
+        with:
+          version: latest
+          args: release --clean
         env:
-          GITHUB_TOKEN: "${{ secrets.RELEASE_GITHUB_TOKEN }}"
+          GITHUB_TOKEN: ${{ secrets.RELEASE_GITHUB_TOKEN }}
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3

diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,5 @@
 .idea/
 dist/**
 main.exe
-coverage.txt
+coverage.txt
+build/
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -0,0 +1,18 @@
+run:
+  timeout: 5m
+linters:
+  enable:
+    - errcheck
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - unused
+    - gci
+linters-settings:
+  gci:
+    sections:
+      - standard
+      - default
+      - prefix(github.com/yonahd/kor)
+    custom-order: true
diff --git a/Makefile b/Makefile
@@ -0,0 +1,13 @@
+.PHONY: *
+
+build:
+	go build -o build/kor main.go
+
+lint:
+	golangci-lint run
+
+lint-fix:
+	golangci-lint run --fix
+
+test:
+	go test -race -coverprofile=coverage.txt -shuffle on ./...
diff --git a/cmd/kor/clusterroles.go b/cmd/kor/clusterroles.go
@@ -4,6 +4,7 @@ import (
 	"fmt"
 
 	"github.com/spf13/cobra"
+
 	"github.com/yonahd/kor/pkg/kor"
 	"github.com/yonahd/kor/pkg/utils"
 )

diff --git a/pkg/kor/clusterroles.go b/pkg/kor/clusterroles.go
@@ -8,13 +8,13 @@ import (
 	"os"
 	"strconv"
 
-	"github.com/yonahd/kor/pkg/filters"
 	v1 "k8s.io/api/rbac/v1"
-	"k8s.io/utils/strings/slices"
-
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/kubernetes"
 	_ "k8s.io/client-go/plugin/pkg/client/auth/oidc"
+	"k8s.io/utils/strings/slices"
+
+	"github.com/yonahd/kor/pkg/filters"
 )
 
 func retrieveUsedClusterRoles(clientset kubernetes.Interface, filterOpts *filters.Options) ([]string, error) {

diff --git a/pkg/kor/clusterroles_test.go b/pkg/kor/clusterroles_test.go
@@ -7,14 +7,14 @@ import (
 	"sort"
 	"testing"
 
-	"github.com/yonahd/kor/pkg/filters"
-
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/kubernetes/fake"
 	"k8s.io/client-go/kubernetes/scheme"
+
+	"github.com/yonahd/kor/pkg/filters"
 )
 
 func createTestClusterRoles(t *testing.T) *fake.Clientset {

diff --git a/pkg/kor/delete.go b/pkg/kor/delete.go
@@ -7,10 +7,9 @@ import (
 	"reflect"
 	"strings"
 
-	batchv1 "k8s.io/api/batch/v1"
-
 	appsv1 "k8s.io/api/apps/v1"
 	autoscalingv1 "k8s.io/api/autoscaling/v1"
+	batchv1 "k8s.io/api/batch/v1"
 	corev1 "k8s.io/api/core/v1"
 	networkingv1 "k8s.io/api/networking/v1"
 	policyv1beta1 "k8s.io/api/policy/v1beta1"

diff --git a/pkg/kor/pods_test.go b/pkg/kor/pods_test.go
@@ -9,7 +9,6 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
-
 	fake "k8s.io/client-go/kubernetes/fake"
 	"k8s.io/client-go/kubernetes/scheme"
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,7 @@ import ( @@
     	"fmt"
     	"github.com/spf13/cobra"
     	"github.com/yonahd/kor/pkg/kor"
     	"github.com/yonahd/kor/pkg/utils"
     )
@@ Expand Down @@