Merge pull request #3575 from garrison/doc-ci-preview

.github/workflows/doc-ci.yml

@@ -0,0 +1,35 @@
+name: doc-ci
+
+on:
+  push:
+    paths:
+      - 'mkdocs.yml'
+      - 'docs/**'
+  pull_request:
+    paths:
+      - 'mkdocs.yml'
+      - 'docs/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: install dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y git virtualenv graphviz
+        virtualenv tmp/docs-virtualenv
+        tmp/docs-virtualenv/bin/pip install -r docs/requirements.txt
+    - name: build docs
+      run: |
+        export PATH=$PWD/tmp/docs-virtualenv/bin:$PATH
+        mkdir docbuild
+        bash -x docs/generate.sh -d docbuild
+        tar cvf docbuild.tar docbuild
+    - name: upload docbuild.tar
+      if: always()
+      uses: actions/upload-artifact@v2
+      with:
+        name: docbuild.tar
+        path: docbuild.tar

docs/README.md

@@ -11,8 +11,7 @@ Run the following.
 sudo apt-get install -y graphviz virtualenv
 cd ~/projects/sandstorm
 virtualenv tmp/docs-virtualenv
-tmp/docs-virtualenv/bin/pip install mkdocs==1.0.4
-tmp/docs-virtualenv/bin/pip install mkdocs-markdown-graphviz==1.3
+tmp/docs-virtualenv/bin/pip install -r docs/requirements.txt
 tmp/docs-virtualenv/bin/mkdocs serve
 ```
 

docs/generate.sh

@@ -50,7 +50,7 @@ assert_dependencies() {
     if [ ! -x "tmp/docs-virtualenv/bin/mkdocs" ] ; then
       mkdir -p tmp
       virtualenv tmp/docs-virtualenv
-      tmp/docs-virtualenv/bin/pip install mkdocs==1.0.4 mkdocs-markdown-graphviz==1.3
+      tmp/docs-virtualenv/bin/pip install -r docs/requirements.txt
     fi
     export PATH=$PWD/tmp/docs-virtualenv/bin:$PATH
   fi

docs/requirements.txt

@@ -0,0 +1,2 @@
+mkdocs==1.0.4
+mkdocs-markdown-graphviz==1.3