Build all docs notebooks in test_notebooks #609
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: Build | |
| on: | |
| pull_request: | |
| branches: [develop] | |
| push: | |
| branches: [develop, master] | |
| workflow_dispatch: | |
| inputs: | |
| reason: | |
| description: Why did you trigger the pipeline? | |
| required: False | |
| default: Check if it runs again due to external changes | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # pandoc needed for docu, see https://nbsphinx.readthedocs.io/en/0.7.1/installation.html?highlight=pandoc#pandoc | |
| - name: Install Non-Python Packages | |
| run: sudo apt-get update -yq && sudo apt-get -yq install pandoc | |
| - uses: actions/[email protected] | |
| with: | |
| fetch-depth: 0 | |
| lfs: true | |
| persist-credentials: false | |
| # lfs=true is not enough, see https://stackoverflow.com/questions/61463578/github-actions-actions-checkoutv2-lfs-true-flag-not-converting-pointers-to-act | |
| - name: Checkout LFS Objects | |
| run: git lfs pull | |
| - name: Merge Develop into Current Branch | |
| if: github.ref != 'refs/heads/develop' | |
| run: | | |
| git fetch origin develop:develop --update-head-ok | |
| git merge develop | |
| - name: Setup Python 3.8 | |
| uses: actions/setup-python@v1 | |
| with: | |
| python-version: "3.8" | |
| # NOTE: Using a cache action is not worth it: Creating/restoring the cache takes longer than installing the packages | |
| - name: Free disk space | |
| run: sh build_scripts/free_disk_space.sh | |
| - name: Install Tox and Python Packages | |
| run: pip install tox | |
| - name: Run Tox | |
| run: tox | |
| - name: Prepare Pages | |
| if: github.ref == 'refs/heads/develop' | |
| run: | | |
| mv docs/build/* public/docs | |
| mv htmlcov/* public/coverage | |
| - name: Deploy Pages | |
| uses: JamesIves/[email protected] | |
| if: github.ref == 'refs/heads/develop' | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| BRANCH: gh-pages | |
| FOLDER: public | |
| TARGET_FOLDER: . | |
| CLEAN: true | |
| SINGLE_COMMIT: true | |
| # post-cache action is executed at the end |