Merge pull request #3 from mart337i/staging

[ADD] Add better docs and minor optimizations

Author: mart337i

.github/workflows/build.yml

@@ -2,7 +2,7 @@ name: Build
 
 on:
   push:
-    branches: [main]
+    branches: [main,staging]
   pull_request:
     branches: [main]
 
@@ -19,6 +19,19 @@ jobs:
         with:
           go-version: '1.22'
 
+      - name: Format check
+        run: |
+          # Check formatting excluding vendor directory
+          UNFORMATTED=$(gofmt -l $(find . -name '*.go' -not -path './vendor/*'))
+          if [ -n "$UNFORMATTED" ]; then
+            echo "Go code is not formatted:"
+            gofmt -d $(find . -name '*.go' -not -path './vendor/*')
+            exit 1
+          fi
+
+      - name: Vet
+        run: make vet
+
       - name: Build
         run: make build
 

Makefile

@@ -1,4 +1,4 @@
-.PHONY: build build-all clean test install
+.PHONY: build build-all clean test install fmt vet
 
 VERSION := $(shell git update-index --refresh >/dev/null 2>&1; git describe --tags --always --dirty 2>/dev/null || echo dev)
 LDFLAGS := -ldflags "-X github.com/egeskov/odooctl/cmd.version=$(VERSION)"
@@ -23,6 +23,14 @@ clean:
 test:
 	go test -v ./...
 
+# Format code (excluding vendor)
+fmt:
+	@find . -name '*.go' -not -path './vendor/*' -exec gofmt -w {} \;
+
+# Run go vet (excluding vendor)
+vet:
+	@go vet $(shell go list ./... | grep -v /vendor/)
+
 # Install to GOPATH/bin
 install:
 	go install $(LDFLAGS) .