Update deploy.yml #99
This file contains hidden or 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: Deploy to gh-pages | |
| on: | |
| push: | |
| branches: [main] | |
| workflow_dispatch: | |
| env: | |
| PYTHON_VERSION: 3.13 | |
| GH_TOKEN: ${{ github.token }} | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| id-token: write | |
| pages: write | |
| jobs: | |
| documentation: | |
| name: Build documentation | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| # This step installs the required system dependencies for lxml | |
| - name: Install lxml dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y libxml2-dev libxslt-dev python3-dev | |
| shell: bash | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| sparse-checkout: | | |
| docs | |
| overrides | |
| .github | |
| - name: Set up Python runtime | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| cache: pip | |
| cache-dependency-path: requirements.txt | |
| - name: Set up build cache | |
| uses: actions/cache/restore@v4 | |
| with: | |
| key: mkdocs-${{ hashfiles('.cache/**') }} | |
| path: .cache | |
| restore-keys: | | |
| mkdocs- | |
| - name: Install Python dependencies | |
| run: pip install -r requirements.txt | |
| - name: Build documentation | |
| run: | | |
| mkdocs build --clean --quiet | |
| - name: Adjust permissions | |
| run: | | |
| chmod -c -R +rX public/ | while read line; do | |
| echo "::info title=Invalid file permissions automatically fixed::$line" | |
| done | |
| - name: Upload to GitHub Pages | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: public | |
| - name: Deploy to GitHub Pages | |
| uses: actions/deploy-pages@v4 | |
| - name: Save build cache | |
| uses: actions/cache/save@v4 | |
| with: | |
| key: mkdocs-${{ hashfiles('.cache/**') }} | |
| path: .cache | |