chore: update make build-docs, add docs build checker (#667)

* update Makefile, add docs build checker * Update .github/workflows/check-docs.yml Co-authored-by: Marko <[email protected]> Co-authored-by: Marko <[email protected]>
cosmos · Dec 23, 2021 · ffc29d9 · ffc29d9
1 parent 297df13
commit ffc29d9
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 1 deletion.
diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml
@@ -0,0 +1,26 @@
+name: Check docs build
+# This workflow runs when a PR is labeled with `docs`
+# This will check if the docs build successfully by running `npm run build`
+on:
+  pull_request:
+  paths:
+      - './docs'
+
+jobs:
+  check-docs-build:
+    if: ${{ github.event.label.name == 'docs' }}
+
+    name: Check docs build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/[email protected]
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+
+      - name: Install dependencies and build docs 🧱
+        run: |
+          cd docs
+          npm install
+          npm run build
diff --git a/Makefile b/Makefile
@@ -196,11 +196,13 @@ godocs:
 build-docs:
 	@cd docs && \
 	while read -r branch path_prefix; do \
-		(git checkout $${branch} && npm install && VUEPRESS_BASE="/$${path_prefix}/" npm run build) ; \
+		echo "building branch $${branch}" ; \
+		(git clean -fdx && git reset --hard && git checkout $${branch} && npm install && VUEPRESS_BASE="/$${path_prefix}/" npm run build) ; \
 		mkdir -p ~/output/$${path_prefix} ; \
 		cp -r .vuepress/dist/* ~/output/$${path_prefix}/ ; \
 		cp ~/output/$${path_prefix}/index.html ~/output ; \
 	done < versions ;
+
 .PHONY: build-docs
 
 ###############################################################################