Add git info for logger

Author: cloverstd

.github/workflows/build_docker.yml

@@ -61,5 +61,8 @@ jobs:
         with:
           context: .
           push: true
+          build-args: |
+            VERSION=main
+            COMMIT=${{ github.sha }}'
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

.github/workflows/release_docker.yml

@@ -11,7 +11,7 @@ name: Create and publish a Docker image
 
 on:
   push:
-    branches: ["release"]
+    branches: ['release']
 env:
   REGISTRY: ghcr.io
   IMAGE_NAME: ${{ github.repository }}
@@ -66,6 +66,9 @@ jobs:
         with:
           context: .
           push: true
+          build-args: |
+            VERSION=release
+            COMMIT=${{ github.sha }}'
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           platforms: linux/amd64,linux/arm64,linux/arm/v7

.github/workflows/version_docker.yml

@@ -12,7 +12,7 @@ name: Create and publish a Docker image
 on:
   push:
     tags:
-      - "v*.*.*"
+      - 'v*.*.*'
 env:
   REGISTRY: ghcr.io
   IMAGE_NAME: ${{ github.repository }}
@@ -67,6 +67,9 @@ jobs:
         with:
           context: .
           push: true
+          build-args: |
+            VERSION=${{ steps.meta.outputs.tags }}
+            COMMIT=${{ github.sha }}'
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           platforms: linux/amd64,linux/arm64,linux/arm/v7

Dockerfile

@@ -1,9 +1,15 @@
+
 FROM golang:1.20-buster AS backend
+
 WORKDIR /app
 COPY backend/go.mod backend/go.sum ./
+
 RUN go mod download
+
 COPY backend/. .
-RUN go build -o main .
+ARG VERSION=unknown
+ARG COMMIT=unknown
+RUN go build -ldflags="-X main.Version=$VERSION -X main.GitHash=$COMMIT" -o main . 
 
 FROM debian:bullseye-slim
 WORKDIR /app

backend/build.sh

@@ -2,9 +2,11 @@
 
 git_repository="https://github.com/HuolalaTech/page-spy-web"
 git_version=$(git describe --tags $(git rev-list --tags --max-count=1))
+git_hash=$(git rev-parse HEAD)
 npm_version=$(echo "$git_version" | sed 's/^v//')
 project_name="page-spy-api"
 organization="@huolala-tech"
+build_with_git_info="-X main.Version=$npm_version -X main.GitHash=$git_hash"
 
 
 GenerateMainPackageJson() {
@@ -141,7 +143,7 @@ BuildRelease() {
 
 	for arch in ${archs[@]}
 	do
-		env GOOS=linux GOARCH=${arch} CGO_ENABLED=0 go build -o ./build/${project_name}-linux-${arch}
+		env GOOS=linux GOARCH=${arch} CGO_ENABLED=0 go build -o ./build/${project_name}-linux-${arch} -ldflags="${build_with_git_info}"
     mkdir -p npm/linux-${arch}/bin
     cp -r ./build/${project_name}-linux-${arch} npm/linux-${arch}/bin/${project_name}
     PublishAndGeneratePackageJson "linux" "${arch}" "npm/linux-${arch}"
@@ -151,7 +153,7 @@ BuildRelease() {
 
 	for arch in ${win_archs[@]}
 	do
-		env GOOS=windows GOARCH=${arch} CGO_ENABLED=0 go build -o ./build/${project_name}-win32-${arch}.exe
+		env GOOS=windows GOARCH=${arch} CGO_ENABLED=0 go build -o ./build/${project_name}-win32-${arch}.exe -ldflags="${build_with_git_info}"
     mkdir -p npm/win32-${arch}
     cp -r ./build/${project_name}-win32-${arch}.exe npm/win32-${arch}/${project_name}.exe
     PublishAndGeneratePackageJson "win32" "${arch}" "npm/win32-${arch}"
@@ -161,7 +163,7 @@ BuildRelease() {
 
 	for arch in ${mac_archs[@]}
 	do
-		env GOOS=darwin GOARCH=${arch} CGO_ENABLED=0 go build -o ./build/${project_name}-darwin-${arch}
+		env GOOS=darwin GOARCH=${arch} CGO_ENABLED=0 go build -o ./build/${project_name}-darwin-${arch} -ldflags="${build_with_git_info}"
     mkdir -p npm/darwin-${arch}/bin
     cp -r ./build/${project_name}-darwin-${arch} npm/darwin-${arch}/bin/${project_name}
     PublishAndGeneratePackageJson "darwin" "${arch}" "npm/darwin-${arch}"

backend/main.go

@@ -12,12 +12,19 @@ import (
 //go:embed dist/*
 var publicContent embed.FS
 
+var (
+	Version string
+	GitHash string
+)
+
 func main() {
 	container := container.Container()
 	err := container.Provide(func() *config.StaticConfig {
 		return &config.StaticConfig{
 			DirName: "dist",
 			Files:   publicContent,
+			Version: Version,
+			GitHash: GitHash,
 		}
 	})