Julia Dependency Update (#259) #695
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: CI with dynamic parallel matrix | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| ALLOWERRORS: 'false' | |
| NBCACHE: '.cache' | |
| JULIA_CONDAPKG_BACKEND: 'Null' | |
| JULIA_NUM_THREADS: 'auto' | |
| JULIA_CI: 'true' | |
| UV_SYSTEM_PYTHON: 1 | |
| jobs: | |
| setup: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| matrix: ${{ steps.set-matrix.outputs.matrix }} | |
| hash: ${{ steps.hash.outputs.value }} | |
| ver: ${{ steps.hash.outputs.ver }} | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| id: setup-python | |
| with: | |
| python-version: '3.x' | |
| - name: Read Julia version | |
| uses: SebRollen/[email protected] | |
| id: read_toml | |
| with: | |
| file: 'Manifest.toml' | |
| field: 'julia_version' | |
| - name: Setup Julia | |
| uses: julia-actions/setup-julia@v2 | |
| with: | |
| version: ${{ steps.read_toml.outputs.value }} | |
| - name: Get environment hash | |
| id: hash | |
| run: | | |
| echo "value=${{ hashFiles('Project.toml', 'Manifest.toml', 'src/**') }}" >> "$GITHUB_OUTPUT" | |
| echo "ver=${{ runner.os }}-julia-${{ steps.read_toml.outputs.value }}" >> "$GITHUB_OUTPUT" | |
| - name: Cache Julia packages | |
| if: ${{ contains(runner.name, 'GitHub Actions') }} | |
| uses: actions/cache@v4 | |
| id: cache-julia | |
| with: | |
| path: ~/.julia | |
| key: ${{ steps.hash.outputs.ver }}-${{ steps.hash.outputs.value }} | |
| restore-keys: | | |
| ${{ steps.hash.outputs.ver }}- | |
| - name: Install Julia packages | |
| if: ${{ runner.environment == 'self-hosted' || steps.cache-julia.outputs.cache-hit != 'true' }} | |
| shell: julia --color=yes {0} | |
| run: | | |
| using Pkg | |
| Pkg.add(["IJulia", "Literate", "JSON"]) | |
| Pkg.activate(".") | |
| Pkg.instantiate() | |
| Pkg.precompile() | |
| - name: List notebooks as a JSON array | |
| id: set-matrix | |
| run: echo "matrix=$(python -c 'import glob, json; print(json.dumps(glob.glob("**/*.ipynb", root_dir="docs", recursive=True) + glob.glob("**/*.jl", root_dir="docs",recursive=True)))')" >> "$GITHUB_OUTPUT" | |
| execute: | |
| needs: setup | |
| strategy: | |
| max-parallel: 20 | |
| fail-fast: false | |
| matrix: | |
| notebook: ${{ fromJSON(needs.setup.outputs.matrix) }} | |
| runs-on: ubuntu-latest | |
| env: | |
| NB: docs/${{ matrix.notebook }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Cache notebook | |
| uses: actions/cache@v4 | |
| id: nb-cache | |
| with: | |
| path: ${{ env.NBCACHE }} | |
| key: ${{ needs.setup.outputs.ver }}-${{ needs.setup.outputs.hash }}-${{ hashFiles(env.NB) }} | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| if: ${{ steps.nb-cache.outputs.cache-hit != 'true' }} | |
| with: | |
| python-version: '3.x' | |
| - name: Install uv | |
| if: ${{ steps.nb-cache.outputs.cache-hit != 'true' }} | |
| run: curl -LsSf https://astral.sh/uv/install.sh | sh | |
| - name: Install Python dependencies | |
| if: ${{ steps.nb-cache.outputs.cache-hit != 'true' }} | |
| run: uv pip install -r requirements.txt | |
| - name: Read Julia version | |
| if: ${{ steps.nb-cache.outputs.cache-hit != 'true' }} | |
| uses: SebRollen/[email protected] | |
| id: read_toml | |
| with: | |
| file: 'Manifest.toml' | |
| field: 'julia_version' | |
| - name: Setup Julia | |
| if: ${{ steps.nb-cache.outputs.cache-hit != 'true' }} | |
| uses: julia-actions/setup-julia@v2 | |
| with: | |
| version: ${{ steps.read_toml.outputs.value }} | |
| - name: Restore Julia packages | |
| if: ${{ runner.environment == 'github-hosted' && steps.nb-cache.outputs.cache-hit != 'true'}} | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.julia | |
| key: ${{ needs.setup.outputs.ver }}-${{ needs.setup.outputs.hash }} | |
| - name: Execute notebook | |
| if: ${{ steps.nb-cache.outputs.cache-hit != 'true' }} | |
| run: julia --project=@. execute.jl | |
| - name: Upload Notebook | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: notebook-${{ needs.setup.outputs.ver }}-${{ needs.setup.outputs.hash }}-${{ hashFiles(env.NB) }} | |
| path: ${{ env.NBCACHE }} | |
| include-hidden-files: true | |
| retention-days: 1 | |
| render: | |
| needs: execute | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Download notebooks | |
| uses: actions/download-artifact@v4 | |
| with: | |
| path: ${{ env.NBCACHE }}/ | |
| pattern: notebook-* | |
| merge-multiple: true | |
| - name: Copy back built notebooks | |
| run: cp --verbose -rf ${{ env.NBCACHE }}/docs/* docs/ | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.x' | |
| - name: Install uv | |
| run: curl -LsSf https://astral.sh/uv/install.sh | sh | |
| - name: Install Python dependencies | |
| run: uv pip install -r requirements-jb.txt | |
| - name: Build website | |
| run: jupyter-book build docs/ | |
| - name: Upload pages artifact | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/_build/html/ | |
| # CI conclusion for GitHub status check | |
| # Adaped from https://brunoscheufler.com/blog/2022-04-09-the-required-github-status-check-that-wasnt | |
| CI: | |
| needs: render | |
| if: always() | |
| runs-on: ubuntu-latest | |
| steps: | |
| - run: | | |
| if [[ ${{ needs.render.result }} == "success" ]]; then | |
| echo "Tests passed" | |
| exit 0 | |
| else | |
| echo "Tests failed" | |
| exit 1 | |
| fi | |
| # Deployment job | |
| 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 | |
| actions: read # to download an artifact uploaded by `actions/upload-pages-artifact@v3` | |
| 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@v4 |