chore: add docs for release archive/image

aquasecurity · Aug 5, 2024 · 5a54e09 · 5a54e09
1 parent 9894e65
commit 5a54e09
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 7 deletions.
diff --git a/Makefile b/Makefile
@@ -953,29 +953,40 @@ protoc:
 # man pages
 #
 
-MARKDOWN_DIR ?= ./docs/docs/flags
-MAN_DIR ?= ./docs/man
+MARKDOWN_DIR ?= docs/docs/flags
+MAN_DIR ?= docs/man
+OUTPUT_MAN_DIR := $(OUTPUT_DIR)/$(MAN_DIR)
 MARKDOW_FILES := $(shell find $(MARKDOWN_DIR) \
 					-type f \
 					-name '*.md' \
 				)
 MAN_FILES := $(patsubst $(MARKDOWN_DIR)/%.md,$(MAN_DIR)/%,$(MARKDOW_FILES))
 
+$(OUTPUT_MAN_DIR): \
+	| .check_$(CMD_MKDIR)
+#
+	$(CMD_MKDIR) -p $@
+
 $(MAN_DIR)/%: $(MARKDOWN_DIR)/%.md \
 	| .check_$(CMD_PANDOC) \
+	$(OUTPUT_MAN_DIR)
 #
-	@echo Generating $@
-	@$(CMD_PANDOC) \
+	@echo Generating $@ && \
+	$(CMD_PANDOC) \
 		--verbose \
 		--standalone \
 		--to man \
 		$< \
-		-o $@
+		-o $@ && \
+	echo Copying $@ to $(OUTPUT_MAN_DIR) && \
+	cp $@ $(OUTPUT_MAN_DIR)
 
 .PHONY: clean-man
 clean-man:
-	@echo Cleaning $(MAN_DIR)
-	@rm -f $(MAN_DIR)/*
+	@echo Cleaning $(MAN_DIR) && \
+	rm -f $(MAN_DIR)/* && \
+	echo Cleaning $(OUTPUT_MAN_DIR) && \
+	rm -rf $(OUTPUT_MAN_DIR)
 
 .PHONY: man
 man: clean-man $(MAN_FILES)

diff --git a/builder/Dockerfile.alpine-tracee-container b/builder/Dockerfile.alpine-tracee-container
@@ -151,11 +151,14 @@ USER root
 ENV HOME=/tracee
 WORKDIR /tracee
 
+RUN apk --no-cache add mandoc
+
 COPY --from=tracee-make /tracee/dist/tracee /tracee
 COPY --from=tracee-make /tracee/dist/tracee-ebpf /tracee
 COPY --from=tracee-make /tracee/dist/tracee-rules /tracee
 COPY --from=tracee-make /tracee/dist/tracee-operator /tracee
 COPY --from=tracee-make /tracee/dist/signatures/ /tracee/signatures/
+COPY --from=tracee-make /tracee/docs/man/ /tracee/docs/man/
 COPY --from=tracee-make /tracee/builder/entrypoint.sh /tracee/entrypoint.sh
 COPY --from=tracee-make /tracee/cmd/tracee-rules/templates/ /tracee/templates/
 

diff --git a/builder/Makefile.release b/builder/Makefile.release
@@ -23,6 +23,7 @@ CMD_DOCKER ?= docker
 CMD_GIT ?= git
 CMD_GITHUB ?= gh
 CMD_MKDIR ?= mkdir
+CMD_CP ?= cp
 CMD_MV ?= mv
 CMD_RM ?= rm
 CMD_TAR ?= tar
@@ -136,6 +137,7 @@ RELEASE_FILES += $(OUTPUT_DIR)/tracee
 RELEASE_FILES += $(OUTPUT_DIR)/tracee-static
 RELEASE_FILES += $(OUTPUT_DIR)/signatures
 #RELEASE_FILES += $(OUTPUT_DIR)/tracee.bpf.o
+RELEASE_FILES += $(OUTPUT_DIR)/docs/man/ # docs path is hardcoded in tracee
 
 OUT_ARCHIVE := $(OUTPUT_DIR)/tracee-$(ARCH).$(SNAPSHOT_VERSION).tar.gz
 OUT_CHECKSUMS := $(OUTPUT_DIR)/checksum-$(ARCH).$(SNAPSHOT_VERSION).txt
@@ -148,6 +150,7 @@ release: \
 	build-tracee-btfhub \
 	build-tracee-binary-static \
 	build-tracee-binary-shared \
+	copy-man \
 	archive \
 	| .check_tree \
 	.check_$(CMD_DOCKER) \
@@ -224,6 +227,12 @@ build-tracee-binary-shared: ubuntu-prepare
 # shared libs
 	BTFHUB=0 STATIC=0 $(MAKE) -f builder/Makefile.tracee-make ubuntu-make ARG="all"
 
+.PHONY: copy-man
+copy-man: \
+	| $(OUTPUT_DIR)
+# man
+	$(CMD_CP) -r --parents docs/man $(OUTPUT_DIR)
+
 .PHONY: archive
 archive:
 # tarball