feat: add Git and Docker metadata to build process and application response

- Introduced build arguments for Git branch, commit, and Docker tag in the Dockerfile and Makefile to enhance traceability of builds.
- Updated GitHub workflows to pass Git and Docker metadata during image builds and releases.
- Modified the application response to include Git and Docker information, improving visibility into the deployed version.

Author: tacxou

.github/workflows/docker-image.yml

@@ -56,3 +56,6 @@ jobs:
           platforms: linux/amd64
           build-args: |
             BUILD_VERSION=${{ steps.version.outputs.version }}-${{ steps.version.outputs.build_id }}
+            GIT_BRANCH=${{ github.ref_name }}
+            GIT_COMMIT=${{ github.sha }}
+            DOCKER_TAG=${{ steps.version.outputs.version }}-${{ steps.version.outputs.build_id }}

.github/workflows/release.yml

@@ -42,4 +42,8 @@ jobs:
           password: ${{ secrets.GITHUB_TOKEN }}
           access_token: ${{ secrets.GITHUB_TOKEN }}
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          build-args: BUILD_VERSION={{NEW_VERSION}}
+          build-args: |
+            BUILD_VERSION={{NEW_VERSION}}
+            GIT_BRANCH=${{ github.ref_name }}
+            GIT_COMMIT=${{ github.sha }}
+            DOCKER_TAG={{NEW_VERSION}}

Dockerfile

@@ -16,8 +16,14 @@ FROM node:22-alpine AS production
 
 ARG NODE_ENV=production
 ARG BUILD_VERSION=dev
+ARG GIT_BRANCH=unknown
+ARG GIT_COMMIT=unknown
+ARG DOCKER_TAG=unknown
 ENV NODE_ENV=${NODE_ENV}
 ENV BUILD_VERSION=${BUILD_VERSION}
+ENV GIT_BRANCH=${GIT_BRANCH}
+ENV GIT_COMMIT=${GIT_COMMIT}
+ENV DOCKER_TAG=${DOCKER_TAG}
 ENV ALLOW_RUNTIME_BUILD=true
 ENV DO_NOT_TRACK=1
 ENV PYTHONWARNINGS=ignore::UserWarning

Makefile

@@ -15,6 +15,10 @@ PLATFORM = "linux/amd64"
 
 include .env
 
+GIT_BRANCH ?= $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null || echo unknown)
+GIT_COMMIT ?= $(shell git rev-parse HEAD 2>/dev/null || echo unknown)
+DOCKER_TAG ?= $(shell git describe --tags --always --dirty 2>/dev/null || echo unknown)
+
 CERT_DIR = ./certificates
 COMMON_NAME = localhost
 DAYS_VALID = 365
@@ -31,12 +35,20 @@ help:
 		| sort | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[32m%-15s\033[0m %s\n", $$1, $$2}'
 
 build: ## Build the container
-	@docker build --platform $(PLATFORM) -t $(IMG_NAME) --no-cache --progress=plain .
+	@docker build --platform $(PLATFORM) -t $(IMG_NAME) --no-cache --progress=plain \
+		--build-arg BUILD_VERSION=$(DOCKER_TAG) \
+		--build-arg GIT_BRANCH=$(GIT_BRANCH) \
+		--build-arg GIT_COMMIT=$(GIT_COMMIT) \
+		--build-arg DOCKER_TAG=$(DOCKER_TAG) \
+		.
 
 simulation: ## Start production environment in simulation mode
 	@docker run --rm -it \
 		-e NODE_ENV=production \
 		-e NODE_TLS_REJECT_UNAUTHORIZED=0 \
+		-e GIT_BRANCH=$(GIT_BRANCH) \
+		-e GIT_COMMIT=$(GIT_COMMIT) \
+		-e DOCKER_TAG=$(DOCKER_TAG) \
 		--add-host host.docker.internal:host-gateway \
 		--platform $(PLATFORM) \
 		--network dev \
@@ -62,6 +74,9 @@ prod: ## Start production environment
 	@docker run --rm -it \
 		-e NODE_ENV=production \
 		-e NODE_TLS_REJECT_UNAUTHORIZED=0 \
+		-e GIT_BRANCH=$(GIT_BRANCH) \
+		-e GIT_COMMIT=$(GIT_COMMIT) \
+		-e DOCKER_TAG=$(DOCKER_TAG) \
 		--add-host host.docker.internal:host-gateway \
 		--platform $(PLATFORM) \
 		--network dev \
@@ -79,6 +94,9 @@ dev: ## Start development environment
 	@docker run --rm -it \
 		-e NODE_ENV=development \
 		-e NODE_TLS_REJECT_UNAUTHORIZED=0 \
+		-e GIT_BRANCH=$(GIT_BRANCH) \
+		-e GIT_COMMIT=$(GIT_COMMIT) \
+		-e DOCKER_TAG=$(DOCKER_TAG) \
 		--add-host host.docker.internal:host-gateway \
 		--platform $(PLATFORM) \
 		--network dev \
@@ -97,6 +115,9 @@ debug: ## Start debug environment
 	@docker run --rm -it \
 		-e NODE_ENV=development \
 		-e NODE_TLS_REJECT_UNAUTHORIZED=0 \
+		-e GIT_BRANCH=$(GIT_BRANCH) \
+		-e GIT_COMMIT=$(GIT_COMMIT) \
+		-e DOCKER_TAG=$(DOCKER_TAG) \
 		--add-host host.docker.internal:host-gateway \
 		--platform $(PLATFORM) \
 		--network dev \

apps/api/src/app.controller.ts

@@ -60,6 +60,13 @@ export class AppController extends AbstractController {
   public getInfo(@Res() res: Response): Response {
     return res.json({
       ...this.appService.getInfo(),
+      git: {
+        branch: process.env.GIT_BRANCH || process.env.GITHUB_REF_NAME || 'unknown',
+        commit: process.env.GIT_COMMIT || process.env.GIT_SHA || process.env.GITHUB_SHA || 'unknown',
+      },
+      docker: {
+        tag: process.env.DOCKER_TAG || process.env.IMAGE_TAG || 'unknown',
+      },
     });
   }