Update PlutoUI #7
This file contains hidden or 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: Export Pluto notebooks | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - master | |
| workflow_dispatch: | |
| # When two jobs run in parallel, cancel the older ones, to make sure that the website is generated from the most recent commit. | |
| concurrency: | |
| group: pluto-export | |
| cancel-in-progress: true | |
| # This action needs permission to write the exported HTML file to the gh-pages branch. | |
| permissions: | |
| contents: write | |
| # (all other permission fields default to "none") | |
| jobs: | |
| build-and-deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout this repository | |
| uses: actions/checkout@v4 | |
| - name: Install Julia | |
| uses: julia-actions/setup-julia@v2 | |
| with: | |
| version: "1" # This will automatically pick the latest Julia version | |
| - name: Cache Julia artifacts & such | |
| uses: julia-actions/cache@v2 | |
| with: | |
| cache-registries: "true" | |
| # We set up a folder that Pluto can use to cache exported notebooks. If the notebook file did not change, then Pluto can take the exported file from cache instead of running the notebook. | |
| - name: Set up notebook state cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: pluto_state_cache | |
| key: ${{ runner.os }}-pluto_state_cache-v2-${{ hashFiles('**/Project.toml', '**/Manifest.toml', '.github/workflows/*' ) }}-${{ hashFiles('**/*jl') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pluto_state_cache-v2-${{ hashFiles('**/Project.toml', '**/Manifest.toml', '.github/workflows/*' ) }} | |
| - name: Run & export Pluto notebooks | |
| run: | | |
| julia -e 'using Pkg | |
| Pkg.activate(mktempdir()) | |
| Pkg.add([ | |
| Pkg.PackageSpec(name="PlutoSliderServer", version="0.3.2-0.3"), | |
| ]) | |
| import PlutoSliderServer | |
| PlutoSliderServer.github_action("."; | |
| Export_cache_dir="pluto_state_cache", | |
| Export_baked_notebookfile=false, | |
| Export_baked_state=false, | |
| # more parameters can go here | |
| )' | |
| - name: Inject top navigation bar and metadata | |
| run: | | |
| INSERT_CODE_HEAD='<link href="https://juliaquantumcontrol.github.io/QuantumControl.jl/dev/assets/topbar/topbar.css" rel="stylesheet" type="text/css"/><script src="https://juliaquantumcontrol.github.io/QuantumControl.jl/dev/assets/topbar/topbar.js"></script>' | |
| INSERT_META_DESCRIPTION='<meta name="description" content="Tutorials for the JuliaQuantumControl Organization."/>' | |
| # The specific text of the above meta tag is required for topbar.js to properly recognized that a page belongs in the "Tutorials" tab | |
| for file in *.html; do | |
| # Use sed with /i to insert the code before the specified location | |
| sed -i "/<\/head>/i $INSERT_CODE_HEAD" "$file" | |
| sed -i "/<meta property='og:type' content='article'>/i $INSERT_META_DESCRIPTION" "$file" | |
| done | |
| - name: Deploy to gh-pages | |
| uses: JamesIves/github-pages-deploy-action@releases/v4 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| branch: gh-pages | |
| folder: . | |
| single-commit: true |