Simplify GitHub Actions documentation update workflow trigger conditions #39
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Update Docs | ||
| on: | ||
| push: | ||
| pull_request: | ||
| workflow_dispatch | ||
| env: | ||
| PYTHON_VERSION: '3.8' | ||
| DEST_REPO: 'openmlsys/html-en' | ||
| GIT_USER_NAME: 'GitHub Actions Bot' | ||
| GIT_USER_EMAIL: 'github-actions[bot]@users.noreply.github.com' | ||
| jobs: | ||
| build-and-deploy: | ||
| runs-on: ubuntu-20.04 | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v3 # Updated to v3 | ||
| with: | ||
| fetch-depth: 0 # Fetch all history for better versioning | ||
| - name: Setup Python | ||
| uses: actions/setup-python@v4 | ||
| with: | ||
| python-version: ${{ env.PYTHON_VERSION }} | ||
| cache: 'pip' # Enable pip caching | ||
| - name: Install system dependencies | ||
| run: | | ||
| sudo apt-get update | ||
| sudo apt-get install -y pandoc | ||
| - name: Setup Python virtual environment | ||
| run: | | ||
| python -m venv venv | ||
| source venv/bin/activate | ||
| pip install --upgrade pip | ||
| - name: Install Python dependencies | ||
| run: | | ||
| source venv/bin/activate | ||
| pip install -r requirements.txt | ||
| pip install sphinx-mathjax-offline | ||
| - name: Install d2l-book | ||
| run: | | ||
| source venv/bin/activate | ||
| git clone https://github.com/openmlsys/d2l-book.git | ||
| cd d2l-book | ||
| pip install . | ||
| cd .. | ||
| - name: Build documentation | ||
| run: | | ||
| source venv/bin/activate | ||
| sh build_html.sh | ||
| - name: Deploy to html-en repository | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GH_TOKEN }} | ||
| run: | | ||
| # Clone the destination repository | ||
| git clone https://${GH_TOKEN}@github.com/${DEST_REPO}.git | ||
| # Copy built documentation | ||
| cp -r _build/html/* html-en/ | ||
| # Configure git | ||
| cd html-en | ||
| git config user.name "${GIT_USER_NAME}" | ||
| git config user.email "${GIT_USER_EMAIL}" | ||
| # Check if there are changes to commit | ||
| if [[ -n $(git status -s) ]]; then | ||
| git add . | ||
| git commit -m "docs: update documentation | ||
| Automated update by GitHub Actions | ||
| Workflow: ${{ github.workflow }} | ||
| Run ID: ${{ github.run_id }} | ||
| Triggered by: ${{ github.event_name }}" | ||
| # Push changes | ||
| git push origin main | ||
| else | ||
| echo "No changes to commit" | ||
| fi | ||
| - name: Clean up | ||
| if: always() | ||
| run: | | ||
| rm -rf venv | ||
| rm -rf html-en | ||
| rm -rf d2l-book | ||
