Publish wkcuber docs to S3 (#392)

* adds doc publish to s3

* ci

* ci

* ci

* ci

* readme + changelog

* readme

Author: normanrz

.github/workflows/main.yml

@@ -18,9 +18,6 @@ jobs:
         python-version: ${{ matrix.python-version }}
         architecture: 'x64'
 
-    - name: Build docker image
-      run: docker build -t scalableminds/webknossos-cuber:$GITHUB_SHA .
-
     - name: Install dependencies
       run: |
         pip install poetry
@@ -42,18 +39,6 @@ jobs:
     - name: Python tests
       run: poetry run pytest tests
 
-    - name: Smoke test docker
-      run: |
-        docker run --rm \
-          -v$(pwd)/testdata:/app/testdata \
-          scalableminds/webknossos-cuber:$GITHUB_SHA \
-          wkcuber.cubing \
-            --jobs 2 \
-            --batch_size 8 \
-            --layer_name color \
-            --wkw_file_len 32 \
-            testdata/tiff testoutput/tiff
-
     - name: Test tiff cubing
       run: tests/scripts/tiff_cubing.sh
 
@@ -95,6 +80,65 @@ jobs:
     - name: Remove reference magnification data
       run: rm -r testdata/tiff_mag_2_reference/
 
+    - name: Generate Docs
+      if: matrix.python-version == '3.8'
+      run: |
+        docs/api.sh --persist
+    
+    - name: Push docs (for branch)
+      if: startsWith(github.event.ref, 'refs/heads') && matrix.python-version == '3.8'
+      env:
+        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        AWS_DEFAULT_REGION: "eu-west-1"
+      run: |
+        CI_BRANCH=${GITHUB_REF##*/}
+        NORMALIZED_CI_BRANCH=${CI_BRANCH//[\/-]/_}
+        aws s3 sync --acl public-read docs/api s3://static.webknossos.org/lib-docs/${NORMALIZED_CI_BRANCH}
+
+    - name: Push docs (for tag)
+      if: startsWith(github.event.ref, 'refs/tags') && matrix.python-version == '3.8'
+      env:
+        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        AWS_DEFAULT_REGION: "eu-west-1"
+      run: |
+        CI_TAG=$(git describe --tags)
+        aws s3 sync --acl public-read docs/api s3://static.webknossos.org/lib-docs/${CI_TAG}
+
+    - name: Check if git is dirty
+      run: |
+        git diff --no-ext-diff --quiet --exit-code
+        [[ -z $(git status -s) ]]
+
+    - name: Publish python package
+      if: startsWith(github.event.ref, 'refs/tags') && matrix.python-version == '3.7'
+      env:
+        PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: ./publish.sh
+
+  docker:
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Build docker image
+      run: docker build -t scalableminds/webknossos-cuber:$GITHUB_SHA .
+
+    - name: Smoke test docker
+      run: |
+        docker run --rm \
+          -v$(pwd)/testdata:/app/testdata \
+          scalableminds/webknossos-cuber:$GITHUB_SHA \
+          wkcuber.cubing \
+            --jobs 2 \
+            --batch_size 8 \
+            --layer_name color \
+            --wkw_file_len 32 \
+            testdata/tiff testoutput/tiff
+
     - name: Login to docker
       env:
         DOCKER_USER: ${{ secrets.DOCKER_USER }}
@@ -130,15 +174,3 @@ jobs:
             scalableminds/webknossos-cuber:latest
           docker push scalableminds/webknossos-cuber:latest
         fi
-
-    - name: Check if git is dirty
-      run: |
-        git diff --no-ext-diff --quiet --exit-code
-        [[ -z $(git status -s) ]]
-
-    - name: Publish python package
-      if: startsWith(github.event.ref, 'refs/tags') && matrix.python-version == '3.7'
-      env:
-        PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-      run: ./publish.sh

Changelog.md

@@ -12,6 +12,7 @@ For upgrade instructions, please check the respective *Breaking Changes* section
 ### Breaking Changes in Config & CLI
 
 ### Added
+- The API documentation is now hosted on a publicwebpage. [#392](https://github.com/scalableminds/webknossos-cuber/pull/392)
 
 ### Changed
 

README.md

@@ -128,7 +128,10 @@ tests/scripts/all_tests.sh
 
 PyPi releases are automatically pushed when creating a new Git tag/Github release. 
 
-## Generate the API documentation
+## API documentation
+Check out the [latest version of the API documentation](https://static.webknossos.org/lib-docs/master/wkcuber/api.html).
+
+### Generate the API documentation
 Run `docs/api.sh` to open a server displaying the API docs. `docs/api.sh --persist` persists the html to `docs/api`.
 
 ## Test Data Credits