Update Makefile and prepare for buildall (#10)

Author: zdw

.github/workflows/pre-merge.yml

@@ -33,7 +33,7 @@ jobs:
         id: filter-changes
         run: |
           folders_to_remove='[".github",".reuse","LICENSES",""]'
-          
+
           changed_projects='${{ steps.discover-changes.outputs.changed_projects }}'
           filtered_projects=$(echo "$changed_projects" | jq -cr --argjson folders_to_remove "$folders_to_remove" 'map(select(. as $item | $folders_to_remove | index($item) | not))')
           echo "filtered_projects=$filtered_projects" >> $GITHUB_OUTPUT
@@ -84,6 +84,7 @@ jobs:
       run_artifact: false
       prefix_tag_separator: "/"
       project_folder: ${{ matrix.project_folder }}
+      trivy_image_skip:  "postgres:16.4"
     secrets: inherit
   final-check:
       runs-on: ubuntu-latest
@@ -93,12 +94,12 @@ jobs:
         - name: Final Status Check
           run: |
             pre_merge_pipeline_result="${{ needs.pre-merge-pipeline.result }}"
-            
+
             echo "Pre-merge pipeline result: $pre_merge_pipeline_result"
-  
+
             if [ "$pre_merge_pipeline_result" == "success" ] || [ "$pre_merge_pipeline_result" == "skipped" ]; then
               echo "Pre-merge check passed successfully."
             else
               echo "Pre-merge checks failed. PR can't get merged"
               exit 1
-            fi
+            fi

Makefile

@@ -1,104 +1,88 @@
 # SPDX-FileCopyrightText: (C) 2025 Intel Corporation
 # SPDX-License-Identifier: Apache-2.0
 
+SHELL	:= bash -eu -o pipefail
+
 SUBPROJECTS := host networking maintenance os-resource telemetry attestationstatus
 
 .DEFAULT_GOAL := help
 .PHONY: all build clean clean-all help lint test
 
-all: build lint test
-	@# Help: Runs build, lint, test stages for all subprojects
+# Repo root directory, where base makefiles are located
+REPO_ROOT := $(dir $(realpath $(lastword $(MAKEFILE_LIST))))
+
+#### Python venv Target ####
+VENV_DIR := venv_managers
+
+$(VENV_DIR): requirements.txt ## Create Python venv
+	python3 -m venv $@ ;\
+  set +u; . ./$@/bin/activate; set -u ;\
+  python -m pip install --upgrade pip ;\
+  python -m pip install -r requirements.txt
+
+all: build lint test ## Runs build, lint, test stages for all subprojects
+
+dependency-check: $(VENV_DIR)
+
+lint: $(VENV_DIR) mdlint license ## lint common and all subprojects
+	for dir in $(SUBPROJECTS); do $(MAKE) -C $$dir lint; done
+
+MD_FILES := $(shell find . -type f \( -name '*.md' \) -print )
+mdlint: ## lint all markdown README.md files
+	markdownlint --version
+	markdownlint *.md
+
+license: $(VENV_DIR) ## Check licensing with the reuse tool
+	set +u; . ./$</bin/activate; set -u ;\
+  reuse --version ;\
+  reuse --root . lint
 
-build:
-	@# Help: Runs build stage in all subprojects
-	@echo "---MAKEFILE BUILD---"
+build: ## build in all subprojects
 	for dir in $(SUBPROJECTS); do $(MAKE) -C $$dir build; done
-	@echo "---END MAKEFILE Build---"
-
-lint:
-	@# Help: Runs lint stage in all subprojects
-	@echo "---MAKEFILE LINT---"
-	@for dir in $(SUBPROJECTS); do $(MAKE) -C $$dir lint; done
-	@echo "---END MAKEFILE LINT---"
-
-mdlint:
-	@# Help: Runs md files linting
-	@echo "---MAKEFILE LINT README---"
-	@markdownlint --version
-	@markdownlint "*.md"
-	@echo "---END MAKEFILE LINT README---"
-
-test:
-	@# Help: Runs test stage in all subprojects
-	@echo "---MAKEFILE TEST---"
+
+docker-build: ## build all docker containers
+	for dir in $(SUBPROJECTS); do $(MAKE) -C $$dir $@; done
+
+docker-push: ## push all docker containers
+	for dir in $(SUBPROJECTS); do $(MAKE) -C $$dir $@; done
+
+docker-list: ## list all docker containers
+	@echo "images:"
+	@for dir in $(SUBPROJECTS); do $(MAKE) -C $$dir $@; done
+
+test: ## test in all subprojects
 	for dir in $(SUBPROJECTS); do $(MAKE) -C $$dir test; done
-	@echo "---END MAKEFILE TEST---"
 
-clean:
-	@# Help: Runs clean stage in all subprojects
-	@echo "---MAKEFILE CLEAN---"
+clean: ## clean in all subprojects
 	for dir in $(SUBPROJECTS); do $(MAKE) -C $$dir clean; done
-	@echo "---END MAKEFILE CLEAN---"
 
-clean-all:
-	@# Help: Runs clean-all stage in all subprojects
-	@echo "---MAKEFILE CLEAN-ALL---"
+clean-all: ## clean-all in all subprojects, and delete virtualenv
 	for dir in $(SUBPROJECTS); do $(MAKE) -C $$dir clean-all; done
-	@echo "---END MAKEFILE CLEAN-ALL---"
+	rm -rf $(VENV_DIR)
 
-h-%:
-	@# Help: Runs host subproject's tasks, e.g. h-test
+h-%: ## Runs host subproject's tasks, e.g. h-test
 	$(MAKE) -C host $*
 
-n-%:
-	@# Help: Runs networking subproject's tasks, e.g. n-test
+n-%: ## Runs networking subproject's tasks, e.g. n-test
 	$(MAKE) -C networking $*
 
-m-%:
-	@# Help: Runs maintenance subproject's tasks, e.g. m-test
+m-%: ## Runs maintenance subproject's tasks, e.g. m-test
 	$(MAKE) -C maintenance $*
 
-osr-%:
-	@# Help: Runs os-resource subproject's tasks, e.g. osr-test
+osr-%: ## Runs os-resource subproject's tasks, e.g. osr-test
 	$(MAKE) -C os-resource $*
 
-t-%:
-	@# Help: Runs telemetry subproject's tasks, e.g. t-test
+t-%: ## Runs telemetry subproject's tasks, e.g. t-test
 	$(MAKE) -C telemetry $*
 
-a-%:
-	@# Help: Runs attestation subproject's tasks, e.g. a-test
+a-%: ## Runs attestationstatus subproject's tasks, e.g. a-test
 	$(MAKE) -C attestationstatus $*
 
-# TODO: move to a common file shared with common.mk
-venv_infra: requirements.txt ## Create Python venv
-	python3 -m venv $@ ;\
-  set +u; . ./$@/bin/activate; set -u ;\
-  python -m pip install --upgrade pip ;\
-  python -m pip install -r requirements.txt
-
-license: venv_infra ## Check licensing with the reuse tool
-	set +u; . ./$</bin/activate; set -u ;\
-  reuse --version ;\
-  reuse --root . lint
-
-dependency-check:
-	echo "No-op to enable CI to pass"
-
-help:
-	@printf "%-20s %s\n" "Target" "Description"
-	@printf "%-20s %s\n" "------" "-----------"
-	@grep -E '^[a-zA-Z0-9_%-]+:|^[[:space:]]+@# Help:' Makefile | \
-	awk '\
-		/^[a-zA-Z0-9_%-]+:/ { \
-			target = $$1; \
-			sub(":", "", target); \
-		} \
-		/^[[:space:]]+@# Help:/ { \
-			if (target != "") { \
-				help_line = $$0; \
-				sub("^[[:space:]]+@# Help: ", "", help_line); \
-				printf "%-20s %s\n", target, help_line; \
-				target = ""; \
-			} \
-		}'
+#### Help Target ####
+help: ## print help for each target
+	@echo infra-managers make targets
+	@echo "Target               Makefile:Line    Description"
+	@echo "-------------------- ---------------- -----------------------------------------"
+	@grep -H -n '^[[:alnum:]%_-]*:.* ##' $(MAKEFILE_LIST) \
+    | sort -t ":" -k 3 \
+    | awk 'BEGIN  {FS=":"}; {sub(".* ## ", "", $$4)}; {printf "%-20s %-16s %s\n", $$3, $$1 ":" $$2, $$4};'

attestationstatus/Makefile

@@ -26,6 +26,7 @@ PROTOCGENGRPCGATEWAY := true
 
 # Project variables
 PROJECT_NAME         := attestationstatusmgr
+PROJECT_NICKNAME     := a
 BINARY_NAME          := ${PROJECT_NAME}
 
 # Code versions, tags, and so on
@@ -34,6 +35,7 @@ VERSION_MAJOR        := $(shell cut -c 1 VERSION)
 DOCKER_IMG_NAME      := $(PROJECT_NAME)
 DOCKER_VERSION       ?= $(shell git branch --show-current | sed 's/\//_/g')
 GIT_COMMIT           ?= $(shell git rev-parse HEAD)
+GIT_TAG_PREFIX       := attestationstatus/v
 
 # Test variables
 # Set TEST_TARGET to '<testname1>' or '<testname1\|testname2>' to run specific tests or use regex '<testname.*>' - example:

attestationstatus/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1-dev

common.mk

@@ -41,10 +41,13 @@ DEPS       := go.mod go.sum
 
 # Docker variables
 DOCKER_ENV              := DOCKER_BUILDKIT=1
-DOCKER_REGISTRY         ?= 080137407410.dkr.ecr.us-west-2.amazonaws.com
-DOCKER_REPOSITORY       ?= edge-orch/infra
-DOCKER_TAG              := $(DOCKER_REGISTRY)/$(DOCKER_REPOSITORY)/$(DOCKER_IMG_NAME):$(VERSION)
-DOCKER_TAG_BRANCH	    := $(DOCKER_REGISTRY)/$(DOCKER_REPOSITORY)/$(DOCKER_IMG_NAME):$(DOCKER_VERSION)
+OCI_REGISTRY            ?= 080137407410.dkr.ecr.us-west-2.amazonaws.com
+OCI_REPOSITORY          ?= edge-orch
+DOCKER_SECTION          := infra
+DOCKER_REGISTRY         ?= $(OCI_REGISTRY)
+DOCKER_REPOSITORY       ?= $(OCI_REPOSITORY)
+DOCKER_TAG              := $(DOCKER_REGISTRY)/$(DOCKER_REPOSITORY)/$(DOCKER_SECTION)/$(DOCKER_IMG_NAME):$(VERSION)
+DOCKER_TAG_BRANCH       := $(DOCKER_REGISTRY)/$(DOCKER_REPOSITORY)/$(DOCKER_SECTION)/$(DOCKER_IMG_NAME):$(DOCKER_VERSION)
 # Decides if we shall push image tagged with the branch name or not.
 DOCKER_TAG_BRANCH_PUSH	?= true
 LABEL_REPO_URL          ?= $(shell git remote get-url $(shell git remote | head -n 1))
@@ -111,7 +114,7 @@ docker-build: ## Build Docker image
 	$(GOCMD) mod vendor
 	cp ../common.mk ../version.mk .
 	docker build . -f Dockerfile \
-		-t $(DOCKER_IMG_NAME):$(DOCKER_VERSION) \
+		-t $(DOCKER_IMG_NAME):$(VERSION) \
 		--build-arg http_proxy="$(http_proxy)" --build-arg HTTP_PROXY="$(HTTP_PROXY)" \
 		--build-arg https_proxy="$(https_proxy)" --build-arg HTTPS_PROXY="$(HTTPS_PROXY)" \
 		--build-arg no_proxy="$(no_proxy)" --build-arg NO_PROXY="$(NO_PROXY)" \
@@ -124,15 +127,19 @@ docker-build: ## Build Docker image
 docker-push: ## Tag and push Docker image
 	# TODO: remove ecr create
 	aws ecr create-repository --region us-west-2 --repository-name $(DOCKER_REPOSITORY)/$(DOCKER_IMG_NAME) || true
-	docker tag $(DOCKER_IMG_NAME):$(DOCKER_VERSION) $(DOCKER_TAG_BRANCH)
-	docker tag $(DOCKER_IMG_NAME):$(DOCKER_VERSION) $(DOCKER_TAG)
+	docker tag $(DOCKER_IMG_NAME):$(VERSION) $(DOCKER_TAG_BRANCH)
+	docker tag $(DOCKER_IMG_NAME):$(VERSION) $(DOCKER_TAG)
 	docker push $(DOCKER_TAG)
 ifeq ($(DOCKER_TAG_BRANCH_PUSH), true)
 	docker push $(DOCKER_TAG_BRANCH)
 endif
 
-docker-list: ## Print all container image names with tags
-	docker images --format "{{.Repository}}:{{.Tag}}"
+docker-list: ## Print name of docker container image
+	@echo "  $(DOCKER_IMG_NAME):"
+	@echo "    name: '$(DOCKER_TAG)'"
+	@echo "    version: '$(VERSION)'"
+	@echo "    gitTagPrefix: '$(GIT_TAG_PREFIX)'"
+	@echo "    buildTarget: '$(PROJECT_NICKNAME)-docker-build'"
 
 #### Python venv Target ####
 

host/Makefile

@@ -28,6 +28,7 @@ PROTOCGENGRPCGATEWAY := true
 
 # Project variables
 PROJECT_NAME         := hostmgr
+PROJECT_NICKNAME     := h
 BINARY_NAME          := $(PROJECT_NAME)
 
 # Code versions, tags, and so on
@@ -36,6 +37,7 @@ VERSION_MAJOR        := $(shell cut -c 1 VERSION)
 DOCKER_IMG_NAME      := $(PROJECT_NAME)
 DOCKER_VERSION       ?= $(shell git branch --show-current | sed 's/\//_/g')
 GIT_COMMIT           ?= $(shell git rev-parse HEAD)
+GIT_TAG_PREFIX       := host/v
 
 # Test variables
 # Set TEST_TARGET to '<testname1>' or '<testname1\|testname2>' to run specific tests or use regex '<testname.*>' - example:

host/VERSION

@@ -1 +1 @@
-1.21.0
+1.21.1-dev

maintenance/Makefile

@@ -25,6 +25,7 @@ PROTOCGENVALIDATEGO := true
 
 # Project variables
 PROJECT_NAME        := maintmgr
+PROJECT_NICKNAME    := m
 BINARY_NAME         := $(PROJECT_NAME)
 
 # Code versions, tags, and so on
@@ -33,6 +34,7 @@ VERSION_MAJOR       := $(shell cut -c 1 VERSION)
 DOCKER_IMG_NAME     := $(PROJECT_NAME)
 DOCKER_VERSION      ?= $(shell git branch --show-current | sed 's/\//_/g')
 GIT_COMMIT          ?= $(shell git rev-parse HEAD)
+GIT_TAG_PREFIX      := maintenance/v
 
 # Test variables
 # Set TEST_TARGET to '<testname1>' or '<testname1\|testname2>' to run specific tests or use regex '<testname.*>' - example:

maintenance/VERSION

@@ -1 +1 @@
-1.21.0
+1.21.1-dev

networking/Makefile

@@ -19,6 +19,7 @@ GOJUNITREPORT      := true
 
 # Project variables
 PROJECT_NAME       := netmgr
+PROJECT_NICKNAME   := n
 BINARY_NAME        := $(PROJECT_NAME)
 
 # Code Versions
@@ -27,6 +28,7 @@ VERSION_MAJOR      := $(shell cut -c 1 VERSION)
 DOCKER_IMG_NAME    := $(PROJECT_NAME)
 DOCKER_VERSION     ?= $(shell git branch --show-current | sed 's/\//_/g')
 GIT_COMMIT         ?= $(shell git rev-parse HEAD)
+GIT_TAG_PREFIX     := networking/v
 
 # Test variables
 # Set TEST_TARGET to '<testname1>' or '<testname1\|testname2>' to run specific tests or use regex '<testname.*>' - example: