Merge pull request #4 from CubicrootXYZ/golang-quality-workflow

add workflow for golang code quality

.github/workflows/golang_quality.yaml

@@ -0,0 +1,50 @@
+on:
+  workflow_call:
+    inputs:
+      workdir:
+        required: false
+        default: "./"
+        type: string
+
+jobs:
+  golangci:
+    runs-on: ubuntu-latest
+    if: "!startsWith(github.ref, 'refs/tags/')"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: v1.22.5
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: v1.59
+          working-directory: "${{ inputs.workdir }}"
+  go_tidy:
+    runs-on: ubuntu-latest
+    if: "!startsWith(github.ref, 'refs/tags/')"
+    container:
+      image: cubicrootxyz/golang-ci:v1.22.5-3
+      options: --user root
+    steps:
+      - uses: actions/checkout@v4
+      - run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+      - name: Run go mod tidy
+        run: (cd ${{ inputs.workdir }} && go mod tidy)
+      - name: Run git diff
+        run: git diff --exit-code
+  go_generate:
+    runs-on: ubuntu-latest
+    if: "!startsWith(github.ref, 'refs/tags/')"
+    container:
+      image: cubicrootxyz/golang-ci:v1.22.5-3
+      options: --user root
+    steps:
+      - uses: actions/checkout@v4
+      - run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+      - name: Install mockgen
+        run: go install github.com/golang/mock/[email protected]
+      - name: Run go generate
+        run: go generate ${{ inputs.workdir }}...
+      - name: Run git diff
+        run: git diff --exit-code

.github/workflows/golang_quality_test.yaml

@@ -0,0 +1,7 @@
+on: push
+
+jobs:
+  golang_quality:
+    uses: ./.github/workflows/golang_quality.yaml
+    with:
+      workdir: "tests/golang_quality"

README.md

@@ -18,3 +18,17 @@ jobs:
       dockerhub_user: ${{ secrets.DOCKERHUB_USERNAME }}
       dockerhub_token: ${{ secrets.DOCKERHUB_TOKEN }}
 ```
+
+## Golang
+
+### Code Quality
+
+To ensure code quality use the provided `golang_quality` workflow. It runs multiple analysis tools.
+
+```yaml
+jobs:
+  golang_quality:
+    uses: ./.github/workflows/golang_quality.yaml
+    with:
+      workdir: "golang/application/subfolder"
+```

tests/golang_quality/go.mod

@@ -0,0 +1,3 @@
+module golang_quality
+
+go 1.22.1

tests/golang_quality/main.go

@@ -0,0 +1,7 @@
+package main
+
+import "fmt"
+
+func main() {
+	fmt.Println("I am used for testing CI workflows")
+}