fix: Call make gen-doc in make test

Signed-off-by: llecoq <[email protected]>

Author: llecoq

.github/workflows/main.yml

@@ -16,11 +16,6 @@ jobs:
           make test
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v3
-      - name: "Test gen doc"
-        run: |
-          make gen-doc
-          # there should not be a diff
-          git diff --quiet || (echo >&2 "make gen-doc has a diff" && false)
   build:
     name: Upload Release Asset
     runs-on: ubuntu-latest

Makefile

@@ -1,5 +1,28 @@
 TEST_OPTS=-v -test.timeout 300s
 
+define gen-doc-in-dir
+	rm -f ./$1/*
+	go run cmd/gen-doc/gen-doc.go $1
+	sed -i.bak 's/.*koyeb completion.*//' ./$1/*.md
+	sed -i.bak 's/### SEE ALSO.*//' ./$1/*.md
+	cat ./$1/koyeb.md >> ./$1/reference.md
+	cat ./$1/koyeb_login.md >> ./$1/reference.md
+	cat ./$1/koyeb_apps.md >> ./$1/reference.md
+	cat ./$1/koyeb_apps_*.md >> ./$1/reference.md
+	cat ./$1/koyeb_domains.md >> ./$1/reference.md
+	cat ./$1/koyeb_domains_*.md >> ./$1/reference.md
+	cat ./$1/koyeb_secrets.md >> ./$1/reference.md
+	cat ./$1/koyeb_secrets_*.md >> ./$1/reference.md
+	cat ./$1/koyeb_services.md >> ./$1/reference.md
+	cat ./$1/koyeb_services_*.md >> ./$1/reference.md
+	cat ./$1/koyeb_deployments.md >> ./$1/reference.md
+	cat ./$1/koyeb_deployments_*.md >> ./$1/reference.md
+	cat ./$1/koyeb_instances.md >> ./$1/reference.md
+	cat ./$1/koyeb_instances_*.md >> ./$1/reference.md
+	cat ./$1/koyeb_version.md >> ./$1/reference.md
+	find ./$1 -type f -not -name 'reference.md' -delete
+endef
+
 help: ## help
 	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_0-9-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort
 
@@ -13,30 +36,18 @@ fmt: ## apply go format
 	gofmt -s -w ./
 
 gen-doc: ## generate markdown documentation
-	rm -f ./docs/*
-	go run cmd/gen-doc/gen-doc.go
-	sed -i.bak 's/.*koyeb completion.*//' ./docs/*.md
-	sed -i.bak 's/### SEE ALSO.*//' ./docs/*.md
-	cat ./docs/koyeb.md >> ./docs/reference.md
-	cat ./docs/koyeb_login.md >> ./docs/reference.md
-	cat ./docs/koyeb_apps.md >> ./docs/reference.md
-	cat ./docs/koyeb_apps_*.md >> ./docs/reference.md
-	cat ./docs/koyeb_domains.md >> ./docs/reference.md
-	cat ./docs/koyeb_domains_*.md >> ./docs/reference.md
-	cat ./docs/koyeb_secrets.md >> ./docs/reference.md
-	cat ./docs/koyeb_secrets_*.md >> ./docs/reference.md
-	cat ./docs/koyeb_services.md >> ./docs/reference.md
-	cat ./docs/koyeb_services_*.md >> ./docs/reference.md
-	cat ./docs/koyeb_deployments.md >> ./docs/reference.md
-	cat ./docs/koyeb_deployments_*.md >> ./docs/reference.md
-	cat ./docs/koyeb_instances.md >> ./docs/reference.md
-	cat ./docs/koyeb_instances_*.md >> ./docs/reference.md
-	cat ./docs/koyeb_version.md >> ./docs/reference.md
-	find ./docs -type f -not -name 'reference.md' -delete
+	$(call gen-doc-in-dir,docs)
 
 test: tidy cmd pkg
-	test -z "`gofmt -d ./cmd ./pkg | tee /dev/stderr`"
-	go test $(TEST_OPTS) ./...
+	@mkdir -p ./.temp
+	@$(call gen-doc-in-dir,.temp)
+	@diff -r -q ./docs ./.temp > /dev/null && { \
+        test -z "`gofmt -d ./cmd ./pkg | tee /dev/stderr`"; \
+        go test $(TEST_OPTS) ./...; \
+    } || { \
+        echo >&2 "make gen-doc has a diff"; \
+	}
+	@rm -rf ./.temp;
 
 lint:
-	golangci-lint run -v ./...
+	golangci-lint run -v ./...

cmd/gen-doc/gen-doc.go

@@ -2,22 +2,23 @@ package main
 
 import (
 	"log"
+	"os"
 	"path"
 	"strings"
 
 	"github.com/koyeb/koyeb-cli/pkg/koyeb"
 	"github.com/spf13/cobra/doc"
 )
 
-func genMarkdownDocumentation() {
+func genMarkdownDocumentation(outputDir string) {
 	rootCmd := koyeb.GetRootCommand()
 	linkHandler := func(name string) string {
 		base := strings.TrimSuffix(name, path.Ext(name))
 		return "#" + strings.Replace(strings.ToLower(base), "_", "-", -1)
 	}
 
 	filePrepender := func(filename string) string {
-		if filename == "docs/koyeb.md" {
+		if filename == outputDir+"/koyeb.md" {
 			return `---
 title: "Koyeb CLI Reference"
 shortTitle: Reference
@@ -34,12 +35,17 @@ If you have not installed the Koyeb CLI yet, please read the [installation guide
 		return ""
 	}
 
-	err := doc.GenMarkdownTreeCustom(rootCmd, "./docs", filePrepender, linkHandler)
+	err := doc.GenMarkdownTreeCustom(rootCmd, outputDir, filePrepender, linkHandler)
 	if err != nil {
 		log.Fatal(err)
 	}
 }
 
 func main() {
-	genMarkdownDocumentation()
+	outputDir := "./docs"
+	if len(os.Args) > 1 {
+		outputDir = os.Args[1]
+	}
+
+	genMarkdownDocumentation(outputDir)
 }