Makefile: replace build-docs by generate

UpCloudLtd · Nov 24, 2023 · c3ec1bb · c3ec1bb
1 parent 65f5224
commit c3ec1bb
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 13 deletions.
diff --git a/.github/workflows/ensure-docs-compiled.yaml b/.github/workflows/ensure-docs-compiled.yaml
@@ -9,14 +9,14 @@ jobs:
         uses: actions/checkout@v2
       - uses: actions/setup-go@v4
       - shell: bash
-        run: make build-docs
+        run: make generate
       - shell: bash
         run: |
           if [[ -z "$(git status -s)" ]]; then
             echo "OK"
           else
             echo "Docs have been updated, but the compiled docs have not been committed."
-            echo "Run 'make build-docs', and commit the result to resolve this error."
+            echo "Run 'make generate', and commit the result to resolve this error."
             exit 1
           fi
 
diff --git a/Makefile b/Makefile
@@ -10,7 +10,7 @@ GOBIN=$(shell go env GOBIN)
 endif
 
 PACKER_SDC=$(GOBIN)/packer-sdc
-PACKER_SDC_RENDER_DOCS=$(PACKER_SDC) renderdocs -src docs-src/ -partials docs-partials/ -dst docs/
+PACKER_SDC_RENDER_DOCS=$(PACKER_SDC) renderdocs -src docs-src/ -partials docs-partials/ -dst .docs/
 
 
 default: build
@@ -36,16 +36,15 @@ install: build
 install-packer-sdc: ## Install packer sofware development command
 	go install github.com/hashicorp/packer-plugin-sdk/cmd/packer-sdc@$(HASHICORP_PACKER_PLUGIN_SDK_VERSION)
 
-ci-release-docs: install-packer-sdc generate
-	@/bin/sh -c "[ -d docs ] && zip -x docs/README.mdx -r docs.zip docs/"
-
 plugin-check: install-packer-sdc build
 	$(PACKER_SDC) plugin-check $(BINARY)
 
 generate: fmt install-packer-sdc
 	@PATH=$(PATH):$(GOBIN) go generate ./...
-	@rm -fr $(CURDIR)/docs # renderdocs doesn't seem to properly overwrite files
+	@if [ -d ".docs" ]; then rm -r ".docs"; fi
 	$(PACKER_SDC_RENDER_DOCS)
+	@./.web-docs/scripts/compile-to-webdocs.sh "." ".docs" ".web-docs" "UpCloudLtd"
+	@rm -r ".docs"
 
 fmt:
 	packer fmt builder/upcloud/test-fixtures/hcl2
@@ -57,10 +56,4 @@ clean:
 	find . -name "TestBuilderAcc_*" -delete
 	find . -name "packer-plugin-upcloud" -delete
 
-build-docs: install-packer-sdc
-	@if [ -d ".docs" ]; then rm -r ".docs"; fi
-	@packer-sdc renderdocs -src "docs" -partials docs-partials/ -dst ".docs/"
-	@./.web-docs/scripts/compile-to-webdocs.sh "." ".docs" ".web-docs" "UpCloudLtd"
-	@rm -r ".docs"
-
 .PHONY: default test test_integration lint build install build-docs