From f02ff421b01239d8676d414e54d633651693bae5 Mon Sep 17 00:00:00 2001
From: Alex Rogozhnikov <iamfullofspam@gmail.com>
Date: Tue, 17 Sep 2024 01:39:02 -0400
Subject: [PATCH] test auto-deployment of documentation

---
 .github/workflows/deploy_docs.yml | 32 +++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 .github/workflows/deploy_docs.yml

diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
new file mode 100644
index 00000000..46d57eab
--- /dev/null
+++ b/.github/workflows/deploy_docs.yml
@@ -0,0 +1,32 @@
+name: deploy-docs
+on:
+  push:
+    branches:
+      # triggers on new commits / merged PRs to main
+      - main
+      - docs-test
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        # credentials of GitHub's public bot, so that commits 'belonged' to bot
+        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.12
+      # - 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-
+      ## original deploy instruction has --force
+      # - run: mkdocs gh-deploy --force
+      - run: pip install hatch && hatch run docs:deploy