Merge pull request #46 from rog-golang-buddies/v0.2.0-review-updates

V0.2.0 review updates #46

Author: haani-niyaz

.github/dependabot.yml

@@ -5,3 +5,7 @@ updates:
   schedule:
     interval: weekly
   open-pull-requests-limit: 5
+- package-ecosystem: "docker"
+  directory: "/"
+  schedule:
+    interval: "weekly"

.github/workflows/SonarCloud.yml

@@ -1,26 +1,22 @@
-name: Gitleaks
-
-on: [pull_request, push, workflow_dispatch]
-
+name: gitleaks
+on: [push]
 jobs:
   gitleaks:
-    name: Secret Scan
     runs-on: ubuntu-latest
     steps:
-          - name: Check out the repo
+          - name: Checkout
             uses: actions/checkout@v2
           - name: Run gitleaks
             run: docker run -v ${{ github.workspace }}:/path zricethezav/gitleaks:latest detect -v --source="/path"  --redact
-
   run-if-failed:
-    name: Github Security Report (if gitleaks job fails)
+    name: gen-report (if gitleaks fails)
     runs-on: ubuntu-latest
     needs: [gitleaks]
     if: always() && (needs.gitleaks.result == 'failure')
     permissions:
       security-events: write
     steps:
-    - name: Check out the repo
+    - name: Checkout
       uses: actions/checkout@v2
     - name: Generate gitleaks SARIF file
       # Exit 0 so we can get the failed report results from this step.

.github/workflows/gitleaks.yml

@@ -1,21 +1,19 @@
 name: golangci-lint
-on:
-  push:
-  pull_request:
+on: [push]
 permissions:
   contents: read
   # Optional: allow read access to pull request. Use with `only-new-issues` option.
   # pull-requests: read
 jobs:
-  golangci:
-    name: lint
+  lint:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/setup-go@v3
         with:
           go-version: 1.17
-      - uses: actions/checkout@v3
-      - name: golangci-lint
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Run linters
         uses: golangci/golangci-lint-action@v3
         with:
           # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version

.github/workflows/go-test.yml

@@ -1,16 +1,19 @@
-name: gen-docs
+name: mkdocs
 on:
   push:
     branches:
-      - master
       - main
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v2
         with:
           python-version: 3.x
-      - run: pip install mkdocs-material
-      - run: mkdocs gh-deploy --force
+      - name: Install mkdocs-material
+        run: pip install mkdocs-material
+      - name: Publish to gh-pages
+        run: mkdocs gh-deploy --force

.github/workflows/golangci-lint.yml

@@ -1,28 +1,29 @@
 name: release
-
 on:
   push:
     branches:
       - main
 jobs:
-  tag:
+  semantic-release:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         node-version:
           - 16.x
     steps:
-      - name: Checkout
+      -
+        name: Checkout
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - name: Release
+      -
+        name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: npx semantic-release
   goreleaser:
     runs-on: ubuntu-latest
-    needs: tag
+    needs: semantic-release
     steps:
       -
         name: Checkout

.github/workflows/mkdocs.yml

@@ -0,0 +1,14 @@
+name: tests
+on: [push]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Setup Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.18
+    - name: Go Test
+      run: go test -v ./...

.github/workflows/release.yml

@@ -4,6 +4,7 @@
 *.dll
 *.so
 *.dylib
+bin/
 
 # Test binary, built with `go test -c`
 *.test
@@ -14,4 +15,9 @@
 # Dependency directories (remove the comment below to include it)
 # vendor/
 
-bin/
+# Code editor personal settings
+.vscode/
+.idea/
+
+# Other
+.DS_Store

.github/workflows/tests.yml

@@ -1,13 +1,22 @@
-FROM golang:1.18 as build
-WORKDIR /go/src/app
+FROM golang:1.18-alpine as builder
+
+RUN apk update && apk upgrade && \
+    apk add --no-cache make bash
+
+WORKDIR /src
 COPY . .
-# Static build requires CGO_ENABLED=0
-RUN mkdir -p /go/bin && CGO_ENABLED=0 go build -ldflags="-w -s" -o /go/bin/app ./...
+
+# Build executable
+RUN make build
 
 # Using a distroless image from https://github.com/GoogleContainerTools/distroless
-# Image sourced from https://console.cloud.google.com/gcr/images/distroless/global/static
 FROM gcr.io/distroless/static:nonroot
-COPY --from=build /go/bin/app /
-# numeric version of user nonroot:nonroot provided in image
+
+# Copy executable from builder image
+COPY --from=builder /src/bin/app /
+
+# Numeric version of user nonroot:nonroot provided in image
 USER 65532:65532
+
+# Run the executable
 CMD ["/app"]