added docs to gh actions

TreyWW · Apr 3, 2024 · 2d3d7c8 · 2d3d7c8
1 parent 8cc5428
commit 2d3d7c8
Show file tree

Hide file tree

Showing 3 changed files with 399 additions and 2 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,41 @@
+name: Publish Documentation
+on:
+  push:
+    branches:
+      - main
+      - feature/new_documentation
+
+# only run one build doc workflow at a time, cancel any running ones
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: |
+          pip install poetry
+          poetry install --only docs
+      - run: mkdocs gh-deploy --force
+        env:
+          UMAMI_PAGE_URL: ${{ secrets.UMAMI_PAGE_URL }}
+          UMAMI_WEBSITE_ID: ${{ secrets.UMAMI_WEBSITE_ID }}