Stamp git commit into docker builds.

Conditionally include git commit into about page.

The if condition is true when the following docker build arg is included

--build-arg=COMMIT=$(git rev-parse --short HEAD)

or when built via github (release.yml)

Dockerfile

@@ -4,6 +4,7 @@ LABEL maintainer="Khanh Ngo <k@ndk.name"
 
 ARG TARGETOS=linux
 ARG TARGETARCH=amd64
+ARG COMMIT=
 
 ARG BUILD_DEPENDENCIES="npm \
     yarn"
@@ -54,7 +55,7 @@ RUN cp -r /build/custom/ assets/
 
 # Build
 RUN rice embed-go && \
-    CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -a -o wg-ui .
+    CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -ldflags="-X main.gitCommit=${COMMIT}" -a -o wg-ui .
 
 # Release stage
 FROM alpine:3.16

README.md

@@ -202,7 +202,13 @@ feature work.
 Go to the project root directory and run the following command:
 
 ```sh
-docker build -t wireguard-ui .
+docker build --build-arg=COMMIT=$(git rev-parse --short HEAD) -t wireguard-ui .
+```
+
+or
+
+```sh
+docker compose build --build-arg=COMMIT=$(git rev-parse --short HEAD)
 ```
 
 ### Build binary file

main.go

@@ -116,6 +116,7 @@ func main() {
 	// set app extra data
 	extraData := make(map[string]string)
 	extraData["appVersion"] = appVersion
+	extraData["gitCommit"] = gitCommit
 	extraData["basePath"] = util.BasePath
 
 	// create rice box for embedded template

templates/about.html

@@ -30,6 +30,12 @@ About
                             <label for="version" class="control-label">Current version</label>
                             <input type="text" class="form-control" id="version" value="{{ .appVersion }}" readonly>
                         </div>
+{{ if .gitCommit }}
+                        <div class="form-group">
+                            <label for="version" class="control-label">git commit hash</label>
+                            <input type="text" class="form-control" id="version" value="{{ .gitCommit }}" readonly>
+                        </div>
+{{ end }}
                         <div class="form-group">
                             <label for="currentReleaseDate" class="control-label">Current version release date</label>
                             <input type="text" class="form-control" id="currentReleaseDate" readonly>