Add preflight checks for clearer failures and reference go.mod where …

…possible (#384)

Closes: #383

It seems like go has a general issue with forward versioning as seen
here: golang/go#55092 and the `gvm`
project does not look to be healthy.

Until some of that dust settles, it makes sense to add a preflight check
to ensure that this repo fails before buildtime if the build environment
is wrong.

1. Add a preflight check such that go is detected in the PATH
1. Adds a preflight check such that go version mismatches are more
explicit
1. Updates CI to reference go.mod to prevent heartburn and headaches

.github/workflows/main.yml

@@ -16,9 +16,9 @@ jobs:
         fetch-depth: 0
     # Go env
     - name: Set up Go
-      uses: actions/setup-go@v4
+      uses: actions/setup-go@v5
       with:
-        go-version: "1.23"
+        go-version-file: 'go.mod'
     # make test
     - name: Test
       run: go test -v ./...
@@ -32,9 +32,12 @@ jobs:
         fetch-depth: 0
     # Go env
     - name: Set up Go
-      uses: actions/setup-go@v4
+      uses: actions/setup-go@v5
       with:
-        go-version: "1.23"
+        go-version-file: 'go.mod'
+    # Preflight checks
+    - name: Preflight checks
+      run: make check-go-version
     # make build
     - name: Build
       run: go build -v cmd/grafana-app-sdk/*.go

.github/workflows/pr.yml

@@ -18,9 +18,9 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set go version
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
-          go-version-file: go.mod
+          go-version-file: 'go.mod'
 
       - name: Update workspace
         run: make update-workspace
@@ -43,9 +43,9 @@ jobs:
         fetch-depth: 0
     # go env
     - name: Set up Go
-      uses: actions/setup-go@v4
+      uses: actions/setup-go@v5
       with:
-        go-version: "1.23"
+        go-version-file: 'go.mod'
     # make lint
     - name: Lint
       uses: golangci/golangci-lint-action@v3
@@ -63,9 +63,9 @@ jobs:
         fetch-depth: 0
     # go env
     - name: Set up Go
-      uses: actions/setup-go@v4
+      uses: actions/setup-go@v5
       with:
-        go-version: "1.23"
+        go-version-file: 'go.mod'
     # make test
     - name: Test
       # find all go.mod files and run go test against directories containing go.mod files
@@ -80,9 +80,12 @@ jobs:
         fetch-depth: 0
     # go env
     - name: Set up Go
-      uses: actions/setup-go@v4
+      uses: actions/setup-go@v5
       with:
-        go-version: "1.23"
+        go-version-file: 'go.mod'
+       # Preflight checks
+    - name: Preflight checks
+      run: make check-go-version
     # make build
     - name: Build
       run: go build -v cmd/grafana-app-sdk/*.go

.github/workflows/release.yml

@@ -21,7 +21,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v5
       with:
-        go-version: "1.23"
+        go-version-file: 'go.mod'
     # make test
     - name: Test
       run: go test -v ./...
@@ -38,7 +38,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v5
       with:
-        go-version: "1.23"
+        go-version-file: 'go.mod'
     # Install the CLI
     - name: Install the CLI
       run: cd cmd/grafana-app-sdk && go install && cd -
@@ -141,7 +141,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v5
       with:
-        go-version: '1.23'
+        go-version-file: 'go.mod'
     # Release
     - name: Create Release
       uses: goreleaser/goreleaser-action@v4

Makefile

@@ -9,10 +9,23 @@ GOWORK		:= go.work
 GOWORKSUM 	:= go.work.sum
 VENDOR  	:= vendor
 COVOUT  	:= coverage.out
+GOVERSION   := $(shell awk '/^go / {print $$2}' go.mod)
+GOBINARY    := $(shell which go)
 
 BIN_DIR := target
 
-all: deps lint test build
+.PHONY: check-go-version
+check-go-version:
+	@if [ -z "$(GOBINARY)" ]; then \
+		echo "Error: No Go binary found. It's a no-go!"; \
+		exit 1; \
+	fi; \
+	if [ "$$($(GOBINARY) version | awk '{print $$3}' | sed 's/go//')" != "$(GOVERSION)" ]; then \
+		echo "Error: Go version $(GOVERSION) is required, but version $$($(GOBINARY) version | awk '{print $$3}' | sed 's/go//') is installed."; \
+		exit 1; \
+	fi
+
+all: check-go-version deps lint test build
 
 deps: $(GOSUM) $(GOWORKSUM)
 $(GOSUM): $(SOURCES) $(GOMOD)