https://github.com/sosiristseng/template-juliabook-matrix
Template for running Julia code in Jupyter Book
https://github.com/sosiristseng/template-juliabook-matrix
julia jupyter-book jupyter-notebook template
Last synced: 25 days ago
JSON representation
Template for running Julia code in Jupyter Book
- Host: GitHub
- URL: https://github.com/sosiristseng/template-juliabook-matrix
- Owner: sosiristseng
- License: mit
- Created: 2022-06-13T05:25:13.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-21T01:26:52.000Z (28 days ago)
- Last Synced: 2025-04-21T02:41:26.523Z (28 days ago)
- Topics: julia, jupyter-book, jupyter-notebook, template
- Homepage: https://sosiristseng.github.io/template-juliabook-matrix/
- Size: 693 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Template for publishing Julia Jupyter notebooks with dynamic matrix
Click `Use this template` button to copy this repository.
See also:
- [template-juliabook](https://github.com/ww-jl/template-juliabook): runs notebooks concurrently *in one runner* and use [jupyter-book][] to build the website.
- [template-quarto-julia-matrix](https://github.com/sosiristseng/template-quarto-julia-matrix): mostly the same as this repository, but it uses quarto to render the website.
[jupyter-book]: https://jupyterbook.org
## Notebook execution and publish
In [ci.yml](.github/workflows/ci.yml), each Jupyter (`*.ipynb`) notebook under the `docs` folder is executed with one GitHub actions runner; then [Jupyter book][jupyter-book] collects the result notebooks and creates a beautiful website.
### Parallel execution
The notebooks are executed in parallel by dynamic matrix. Every notebook runs on an individual runner.
### Enable GitHub pages
Open your repository settings => Pages => GitHub Pages => Build and deployment => Source, select `GitHub actions`.
## Automatic dependency updates
### Dependabot and Kodiak Bot
See [dependabot.yml](.github/dependabot.yml) and [.kodiak.toml](.github/.kodiak.toml) configuration files.
You need to enable the [Kodiak Bot](https://kodiakhq.com/docs/quickstart) APP to automatically merge updates.
### Julia dependencies
The GitHub workflow [update-manifest.yml](.github/workflows/update-manifest.yml) regularly updates Julia dependencies, make a PR with the updated dependencies, and automatically merge the updates if the notebooks are executed smoothly.
See [creating tokens](https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#triggering-further-workflow-runs) to trigger CI workflows in a PR. This repo uses a custom [GitHub APP](https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#authenticating-with-github-app-generated-tokens) to generate a token on the fly.
## Checking HTTP links
[linkcheck.yml](.github/workflows/linkcheck.yml) uses GitHub actions to regularly check if the web links in the notebooks are valid.