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 notebooks and publish | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| NPROC: '2' # Number of Julia processes to run the notebooks | |
| PYTHON_VER: '3.11' | |
| jobs: | |
| execute: | |
| runs-on: ubuntu-latest | |
| container: | |
| image: julia:1.9.3 | |
| env: | |
| JULIA_CPU_TARGET: 'generic;haswell,clone_all' | |
| JULIA_NUM_THREADS: auto | |
| JULIA_CONDAPKG_BACKEND: 'Null' | |
| JULIA_CI: 'true' | |
| GKSwstype: '100' # Null GR backend for Plots.jl | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.PYTHON_VER }} | |
| - name: Install Python deps | |
| run: python -m pip install --no-cache-dir -r requirements.txt | |
| - name: Cache Julia deps | |
| uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.julia/artifacts | |
| ~/.julia/compiled | |
| ~/.julia/packages | |
| ~/.julia/environments | |
| key: ${{ runner.os }}-juliacontainer-${{ hashFiles('src/**','Project.toml', 'Manifest.toml')}} | |
| restore-keys: | | |
| ${{ runner.os }}-juliacontainer- | |
| - name: Install Julia deps | |
| env: | |
| PYTHON: ${{ env.pythonLocation }}/python | |
| JULIA_PYTHONCALL_EXE: ${{ env.pythonLocation }}/python | |
| run: | | |
| julia --color=yes -e 'using Pkg; Pkg.add(["PrettyTables", "Literate"])' | |
| julia --project=@. --color=yes -e 'using Pkg; Pkg.activate("."); Pkg.instantiate(); Pkg.gc()' | |
| - name: Run program | |
| env: | |
| JULIA_PROJECT: '@.' | |
| run: julia --color=yes -p ${{ env.NPROC }} literate.jl | |
| - name: Upload Results | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: notebooks | |
| path: docs/ | |
| retention-days: 1 | |
| render: | |
| needs: execute | |
| runs-on: ubuntu-latest | |
| # store success output flag for the ci job | |
| outputs: | |
| success: ${{ steps.setoutput.outputs.success }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Download notebooks | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: notebooks | |
| path: out/ | |
| - name: Display structure of downloaded files | |
| run: ls -R | |
| working-directory: out | |
| - name: Copy back built notebooks | |
| run: cp --verbose -rf out/* docs/ | |
| - name: Setup micromamba | |
| uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-file: jupyterbook.yml | |
| init-shell: bash | |
| cache-environment: true | |
| post-cleanup: all | |
| - name: Build website | |
| shell: micromamba-shell {0} | |
| run: jupyter-book build docs/ | |
| - name: Upload pages artifact | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| path: docs/_build/html | |
| - name: Set output flag | |
| id: setoutput | |
| run: echo "success=true" >> $GITHUB_OUTPUT | |
| # CI conclusion for GitHub status check | |
| # https://brunoscheufler.com/blog/2022-04-09-the-required-github-status-check-that-wasnt | |
| CI: | |
| needs: render | |
| if: always() | |
| runs-on: ubuntu-latest | |
| steps: | |
| # pass step only when output of previous jupyter-book job is set | |
| # in case at least one of the execution fails, jupyter-book is skipped | |
| # and the output will not be set, which will then cause the ci job to fail | |
| - run: | | |
| passed="${{ needs.render.outputs.success }}" | |
| if [[ $passed == "true" ]]; then | |
| echo "Tests passed" | |
| exit 0 | |
| else | |
| echo "Tests failed" | |
| exit 1 | |
| fi | |
| deploy: | |
| name: Deploy to GitHub pages | |
| needs: render | |
| if: ${{ github.ref == 'refs/heads/main'}} | |
| # Grant GITHUB_TOKEN the permissions required to make a Pages deployment | |
| permissions: | |
| pages: write # to deploy to Pages | |
| id-token: write # to verify the deployment originates from an appropriate source | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 |