This repository has been archived by the owner on Feb 1, 2024. It is now read-only.
Bump actions/checkout from 3 to 4 #228
Workflow file for this run
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: "Deploy Docs" | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| jobs: | |
| # https://github.com/marketplace/actions/deploy-to-github-pages | |
| build-docs-deploy: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Checkout 🛎️ | |
| uses: actions/checkout@v4 | |
| with: | |
| persist-credentials: false | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.8 | |
| # Note: This uses an internal pip API and may not always work | |
| # https://github.com/actions/cache/blob/master/examples.md#multiple-oss-in-a-workflow | |
| - name: Cache pip | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pip | |
| key: pip-${{ hashFiles('requirements.txt') }} | |
| restore-keys: pip- | |
| - name: Install dependencies | |
| run: | | |
| pip install "pip<23.0" # HotFix for bad Horovod requirements | |
| pip install -U -q -r requirements.txt -r docs/requirements.txt \ | |
| -f https://download.pytorch.org/whl/cpu/torch_stable.html | |
| # install Texlive, see https://linuxconfig.org/how-to-install-latex-on-ubuntu-20-04-focal-fossa-linux | |
| pip list | |
| - name: Make Documentation | |
| working-directory: ./docs | |
| run: make html --jobs 2 | |
| - name: Deploy 🚀 | |
| uses: JamesIves/[email protected] | |
| if: ${{ github.event_name == 'push' }} | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: docs/build/html # The folder the action should deploy. | |
| clean: true # Automatically remove deleted files from the deploy branch | |
| target-folder: docs # If you'd like to push the contents of the deployment folder into a specific directory | |
| single-commit: true # you'd prefer to have a single commit on the deployment branch instead of full history |