Skip to content

Commit

Permalink
no matrix
Browse files Browse the repository at this point in the history
  • Loading branch information
sosiristseng committed Sep 1, 2024
1 parent 0612ea8 commit b7ce3c4
Show file tree
Hide file tree
Showing 6 changed files with 187 additions and 201 deletions.
175 changes: 41 additions & 134 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: CI with dynamic parallel matrix
name: CI

on:
workflow_dispatch:
Expand All @@ -12,20 +12,18 @@ concurrency:
cancel-in-progress: true

env:
NBCONVERT_JOBS: '4'
LITERATE_PROC: '4'
ALLOWERRORS: 'false'
NBCACHE: '.cache'
CACHE_NUM: '1'
JULIA_CONDAPKG_BACKEND: 'Null'
JULIA_NUM_THREADS: 'auto'
JULIA_CI: 'true'
NBCACHE: '.cache'
UV_SYSTEM_PYTHON: 1

jobs:
setup:
CI:
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.set-matrix.outputs.matrix }}
hash: ${{ steps.hash.outputs.value }}
steps:
- name: Checkout repository
uses: actions/checkout@v4
Expand All @@ -34,6 +32,18 @@ jobs:
id: setup-python
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.txt
- name: Cache executed notebooks
uses: actions/cache@v4
id: cache-nb
with:
path: ${{ env.NBCACHE }}
key: ${{ runner.os }}-nb-${{ env.CACHE_NUM }}-${{ hashFiles('src/**', 'Project.toml', 'Manifest.toml', 'requirements.txt') }}-${{ hashFiles('docs/**/*.ipynb', 'docs/**/*.jl') }}
restore-keys: |
${{ runner.os }}-nb-${{ env.CACHE_NUM }}-${{ hashFiles('src/**', 'Project.toml', 'Manifest.toml', 'requirements.txt') }}-
- name: Read Julia version
uses: SebRollen/[email protected]
id: read_toml
Expand All @@ -44,16 +54,13 @@ jobs:
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"
- name: Cache Julia packages
if: ${{ contains(runner.name, 'GitHub Actions') }}
uses: actions/cache@v4
- name: Restore Julia packages
uses: actions/cache/restore@v4
if: ${{ runner.environment == 'github-hosted' }}
id: cache-julia
with:
path: ~/.julia
key: ${{ runner.os }}-julia-${{ env.CACHE_NUM }}-${{ steps.read_toml.outputs.value }}-${{ steps.hash.outputs.value }}
key: ${{ runner.os }}-julia-${{ env.CACHE_NUM }}-${{ steps.read_toml.outputs.value }}-${{ hashFiles('src/**', 'Project.toml', 'Manifest.toml') }}
restore-keys: |
${{ runner.os }}-julia-${{ env.CACHE_NUM }}-${{ steps.read_toml.outputs.value }}-
- name: Install Julia packages
Expand All @@ -65,131 +72,31 @@ jobs:
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:
# Notebooks need to be executed
notebook: ${{ fromJSON(needs.setup.outputs.matrix) }}
runs-on: ubuntu-latest
env:
NB: docs/${{ matrix.notebook }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Restore notebook if present
uses: actions/cache/restore@v4
id: nb-cache
with:
path: ${{ env.NBCACHE }}
key: ${{ runner.os }}-notebook-${{ env.CACHE_NUM }}-${{ 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/restore@v4
with:
path: ~/.julia
key: ${{ runner.os }}-julia-${{ env.CACHE_NUM }}-${{ steps.read_toml.outputs.value }}-${{ needs.setup.outputs.hash }}
restore-keys: |
${{ runner.os }}-julia-${{ env.CACHE_NUM }}-${{ steps.read_toml.outputs.value }}-
- name: Execute notebook
if: ${{ steps.nb-cache.outputs.cache-hit != 'true' }}
run: julia execute.jl
- name: Cache notebook
uses: actions/cache/save@v4
if: ${{ steps.nb-cache.outputs.cache-hit != 'true' }}
with:
path: ${{ env.NBCACHE }}
key: ${{ steps.nb-cache.outputs.cache-primary-key }}
- name: Upload Notebook
uses: actions/upload-artifact@v4
with:
name: ${{ steps.nb-cache.outputs.cache-primary-key }}
path: ${{ env.NBCACHE }}
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: ${{ runner.os }}-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
- name: Save Julia packages
uses: actions/cache/save@v4
if: ${{ runner.environment == 'github-hosted' && steps.cache-julia.outputs.cache-hit != 'true' }}
with:
path: ~/.julia
key: ${{ steps.cache-julia.outputs.cache-primary-key }}
- name: Run notebooks
run: julia --color=yes -p ${{ env.LITERATE_PROC }} --heap-size-hint=3G run.jl
- name: Copy back built notebooks
run: cp --verbose -rf ${{ env.NBCACHE }}/docs/* docs/
- 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/

# Deployment job
# Deploy pages
deploy:
name: Deploy to GitHub pages
needs: render
needs: CI
if: ${{ github.ref == 'refs/heads/main' }}
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
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:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/linkcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ jobs:
- 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
run: uv pip install -r requirements.txt
- name: Build website
run: jupyter-book build ${DIR} --builder linkcheck
64 changes: 0 additions & 64 deletions execute.jl

This file was deleted.

1 change: 0 additions & 1 deletion requirements-jb.txt

This file was deleted.

3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
matplotlib==3.9.2
# matplotlib==3.9.2
nbconvert==7.16.4
jupyter-book==1.0.2
Loading

0 comments on commit b7ce3c4

Please sign in to comment.