refactor: check docs

GreptimeTeam · Dec 15, 2023 · aed8652 · aed8652
1 parent 1f927af
commit aed8652
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 39 deletions.
diff --git a/.github/scripts/check-update-docs.sh b/.github/scripts/check-update-docs.sh
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -11,9 +11,9 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Check update docs
+      - name: Check docs
         run: |
-          make check-update-docs    
+          make check-docs    
 
       - name: Install Helm
         uses: azure/setup-helm@v3

diff --git a/Makefile b/Makefile
@@ -11,14 +11,14 @@ endif
 install-helm-docs: ## Install helm-docs tool
 	go install github.com/norwoodj/helm-docs/cmd/helm-docs@${HELM_DOCS_VERSION}
 
-.PHONY: update-docs
-update-docs: install-helm-docs ## Run helm-docs
+.PHONY: docs
+docs: install-helm-docs ## Run helm-docs
 	$(GOBIN)/helm-docs -c charts/greptimedb-cluster --chart-search-root=charts/greptimedb-cluster --template-files=README.md.gotmpl
 	$(GOBIN)/helm-docs -c charts/greptimedb-operator --chart-search-root=charts/greptimedb-operator --template-files=README.md.gotmpl
 	$(GOBIN)/helm-docs -c charts/greptimedb-standalone --chart-search-root=charts/greptimedb-standalone --template-files=README.md.gotmpl
 
-.PHONY: check-update-docs
-check-update-docs: ## Check update docs.
-	echo "Checking update docs"
-	.github/scripts/check-update-docs.sh
-
+.PHONY: check-docs
+check-docs: docs ## Check docs
+	@git diff --quiet || \
+    (echo "Need to update documentation, please run 'make docs'"; \
+	exit 1)