From 3e1a51dd42897b97c8fde260a93ca03c5eda17c2 Mon Sep 17 00:00:00 2001
From: Alleria <xiaoyigu@usc.edu>
Date: Mon, 22 Jul 2024 16:09:31 -0700
Subject: [PATCH] test the deployment

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

diff --git a/.github/workflows/documentation_test.yml b/.github/workflows/documentation_test.yml
new file mode 100644
index 00000000..3c12d6fe
--- /dev/null
+++ b/.github/workflows/documentation_test.yml
@@ -0,0 +1,71 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - merge-main-into-release # Trigger the workflow when changes are pushed to the release branch
+
+permissions:
+  contents: write
+  actions: read
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch all history for all branches and tags
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11' # Ensure the Python version is correct
+
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+          echo "$HOME/.local/bin" >> $GITHUB_PATH  # Ensure Poetry's bin directory is in PATH
+
+      - name: Install root dependencies(expecially doc dependencies) using Poetry
+        run: |
+          poetry config virtualenvs.create false  # Avoid creating a virtual environment
+          poetry install --only docs  # Install only the documentation dependencies
+
+      - name: Install package dependencies
+        run: |
+          cd lightrag
+          poetry install  # Install package dependencies
+
+      - name: Build documentation using Makefile
+        run: |
+          echo "Building documentation from: $(pwd)"
+          ls -l  # Debug: List current directory contents
+          poetry run make html  # Run Makefile in docs directory to build HTML docs
+        working-directory: ${{ github.workspace }}/docs
+
+      - name: List built documentation
+        run: |
+          find ./docs/build/ -type f  # List all files in the build directory
+        working-directory: ${{ github.workspace }}
+
+      - name: Create .nojekyll file
+        run: |
+          touch .nojekyll  # Prevent GitHub Pages from ignoring files that start with an underscore
+        working-directory: ${{ github.workspace }}/docs/build
+
+      - name: Copy CNAME file
+        run: |
+          cp ${{ github.workspace }}/CNAME ${{ github.workspace }}/docs/build/CNAME || true
+        working-directory: ${{ github.workspace }}
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }} # GitHub token for authentication
+          publish_branch: gh-pages # Target branch for GitHub Pages deployment
+          publish_dir: ./docs/build/ # Directory containing the built documentation
+          user_name: github-actions[bot] # Username for the commit
+          user_email: github-actions[bot]@users.noreply.github.com # Email for the commit