Skip to content

sosiristseng/template-juliabook-matrix

Repository files navigation

Template for publishing Julia Jupyter notebooks with dynamic matrix

Click Use this template button to copy this repository.

See also:

Notebook execution and publish

In ci.yml, each Jupyter (*.ipynb) notebook under the docs folder is executed with one GitHub actions runner; then 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 and .kodiak.toml configuration files.

You need to enable the Kodiak Bot APP to automatically merge updates.

Julia dependencies

The GitHub workflow 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 to trigger CI workflows in a PR. This repo uses a custom GitHub APP to generate a token on the fly.

Checking HTTP links

linkcheck.yml uses GitHub actions to regularly check if the web links in the notebooks are valid.