Merge pull request #5 from prometheus-operator/go-checks

Go checks

.github/env

@@ -0,0 +1 @@
+golang-version=1.22

.github/workflows/checks.yaml

@@ -0,0 +1,56 @@
+name: checks
+on:
+  pull_request:
+  push:
+    branches:
+      - 'main'
+jobs:
+  check-docs:
+    runs-on: ubuntu-latest
+    name: Check Documentation formatting and links
+    steps:
+    - uses: actions/checkout@v4
+    - name: Import environment variables from file
+      run: cat ".github/env" >> $GITHUB_ENV
+    - uses: actions/setup-go@v5
+      with:
+        go-version: '${{ env.golang-version }}'
+        check-latest: true
+    - run: make check-docs
+
+  check-golang:
+    runs-on: ubuntu-latest
+    name: Golang linter
+    steps:
+      - uses: actions/checkout@v4
+      - name: Import environment variables from file
+        run: cat ".github/env" >> $GITHUB_ENV
+      - uses: actions/setup-go@v5
+        with:
+          go-version: '${{ env.golang-version }}'
+          check-latest: true
+      - name: go.mod
+        run: make tidy && git diff --exit-code
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6.0.1
+        with:
+          version: v1.57.2
+          args: --timeout 10m0s --go ${{ env.golang-version }}
+
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - macos-latest
+          - ubuntu-latest
+    name: Build operator binary
+    steps:
+    - uses: actions/checkout@v4
+    - name: Import environment variables from file
+      run: cat ".github/env" >> $GITHUB_ENV
+    - uses: actions/setup-go@v5
+      with:
+        go-version: '${{ env.golang-version }}'
+        check-latest: true
+    - run: make poctl

.golangci.yaml

@@ -0,0 +1,25 @@
+run:
+  deadline: 10m
+
+linters:
+  enable:
+  - revive
+  - depguard
+  - godot
+  - testifylint
+  - unconvert
+
+issues:
+  exclude-rules:
+  # Disable errcheck linter for test files.
+  - path: _test.go
+    linters:
+    - errcheck
+
+linters-settings:
+  depguard:
+    rules:
+      forbid-pkg-errors:
+        deny:
+        - pkg: "github.com/pkg/errors"
+          dsc: Should be replaced with standard lib errors or fmt.Errorf

Makefile

@@ -2,17 +2,47 @@ TOOLS_BIN_DIR ?= $(shell pwd)/tmp/bin
 
 export PATH := $(TOOLS_BIN_DIR):$(PATH)
 
+GO_BUILD_RECIPE=\
+	GOOS=$(GOOS) \
+	GOARCH=$(GOARCH) \
+	CGO_ENABLED=0 \
+	go build
+
+GOLANGCILINTER_BINARY=$(TOOLS_BIN_DIR)/golangci-lint
 MDOX_BINARY=$(TOOLS_BIN_DIR)/mdox
 MDOX_VALIDATE_CONFIG?=.mdox.validate.yaml
 
-TOOLING=$(MDOX_BINARY)
+TOOLING=$(MDOX_BINARY) $(GOLANGCILINTER_BINARY)
 
 MD_FILES_TO_FORMAT=$(shell ls *.md)
 
+.PHONY: docs
 docs: $(MDOX_BINARY)
 	@echo ">> formatting and local/remote link check"
 	$(MDOX_BINARY) fmt --soft-wraps -l --links.localize.address-regex="https://prometheus-operator.dev/.*" --links.validate.config-file=$(MDOX_VALIDATE_CONFIG) $(MD_FILES_TO_FORMAT)
 
+.PHONY: check-docs
+check-docs: $(MDOX_BINARY)
+	@echo ">> checking formatting and local/remote links"
+	$(MDOX_BINARY) fmt --soft-wraps --check -l --links.localize.address-regex="https://prometheus-operator.dev/.*" --links.validate.config-file=$(MDOX_VALIDATE_CONFIG) $(MD_FILES_TO_FORMAT)
+
+.PHONY: check-golang
+check-golang: $(GOLANGCILINTER_BINARY)
+	$(GOLANGCILINTER_BINARY) run
+
+.PHONY: fix-golang
+fix-golang: $(GOLANGCILINTER_BINARY)
+	$(GOLANGCILINTER_BINARY) run --fix
+
+.PHONY: tidy
+tidy:
+	go mod tidy -v
+	cd scripts && go mod tidy -v -modfile=go.mod -compat=1.18
+
+.PHONY: poctl
+poctl:
+	$(GO_BUILD_RECIPE) -o $@ main.go
+
 $(TOOLS_BIN_DIR):
 	mkdir -p $(TOOLS_BIN_DIR)
 

cmd/create.go

@@ -7,7 +7,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// createCmd represents the create command
+// createCmd represents the create command.
 var createCmd = &cobra.Command{
 	Use:   "create",
 	Short: "create is used to create Prometheus Operator resources.",

cmd/root.go

@@ -10,7 +10,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// rootCmd represents the base command when called without any subcommands
+// rootCmd represents the base command when called without any subcommands.
 var rootCmd = &cobra.Command{
 	Use:   "poctl",
 	Short: "poctl is a command line interface for managing Prometheus Operator.",

cmd/stack.go

@@ -11,12 +11,12 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// stackCmd represents the stack command
+// stackCmd represents the stack command.
 var stackCmd = &cobra.Command{
 	Use:   "stack",
 	Short: "create a stack of Prometheus Operator resources.",
 	Long:  `create a stack of Prometheus Operator resources.`,
-	Run: func(cmd *cobra.Command, args []string) {
+	Run: func(_ *cobra.Command, _ []string) {
 		logger, err := log.NewLogger()
 		if err != nil {
 			fmt.Println(err)