publish exactly whats needed

Author: d-rk

.github/workflows/publish_ghpages.yml

@@ -18,9 +18,9 @@ jobs:
           go-version-file: 'go.mod'
       -
         name: Build and generate docs
-        run: make docs
+        run: make docs DOCS_TARGET=pages
       -
         name: Deploy
         uses: JamesIves/github-pages-deploy-action@v4
         with:
-          folder: docs
+          folder: pages

Makefile

@@ -1,6 +1,7 @@
 BUILD_TS := $(shell date -Iseconds -u)
 COMMIT_SHA := $(shell git rev-parse HEAD)
 VERSION := $(shell git describe --abbrev=0 --tags || echo "latest")
+DOCS_TARGET ?= docs
 
 export CGO_ENABLED=0
 
@@ -48,7 +49,9 @@ build:
 .PHONY: docs
 docs: build
 	touch /tmp/empty.yaml
-	./kafkactl docs --directory docs --single-page --config-file=/tmp/empty.yaml
+	./kafkactl docs --directory $(DOCS_TARGET) --single-page --config-file=/tmp/empty.yaml
+	echo "![version](https://img.shields.io/badge/version-$(VERSION)-blue)" > $(DOCS_TARGET)/version.md
+	cp index.md $(DOCS_TARGET)
 
 .PHONY: clean
 clean:

index.md

@@ -1,3 +1,5 @@
 # kafkactl command documentation
 
-{% include_relative docs/kafkactl_docs.md %}
+{% include_relative version.md %}
+
+{% include_relative kafkactl_docs.md %}